Skip to content

File-src-minisql-protocol-constants-ml-2117523449.md

Latest commit

 

History

History
399 lines (233 loc) · 13.1 KB

File-src-minisql-protocol-constants-ml-2117523449.md

File metadata and controls

399 lines (233 loc) · 13.1 KB
Raw

src/minisql/protocol/constants.ml

Home · Files

Provides minisql protocol constants facilities for this project.

Package: minisql.protocol.constants

Reachable from entry: yes

Declarations

componentName

function componentName()

Performs the componentName operation for the minisql protocol constants module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

View source

DEFAULT_RESULT_BATCH_ROWS

const DEFAULT_RESULT_BATCH_ROWS = 512

Defines the default result batch rows constant used by the minisql protocol constants module.

View source

FLAG_MORE

const FLAG_MORE = 2

Indicates that another response frame with the same request identifier follows.

View source

FLAG_SECURE

const FLAG_SECURE = 1

Defines the flag secure constant used by the minisql protocol constants module.

View source

HEADER_BYTES

const HEADER_BYTES = 32

Defines the header bytes constant used by the minisql protocol constants module.

View source

HEADER_CRC_OFFSET

const HEADER_CRC_OFFSET = 24

Defines the header crc offset constant used by the minisql protocol constants module.

View source

isImplemented

function isImplemented()

Returns whether implemented satisfies the condition required by the minisql protocol constants module. Returns the computed value or operation status. Does not modify its inputs.

View source

knownType

function knownType(value)

Implements known type for this module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter Type Default Description
value dynamic — Value consumed or transformed by the operation.

View source

MAX_COLUMNS

const MAX_COLUMNS = 1024

Defines the max columns constant used by the minisql protocol constants module.

View source

MAX_PAYLOAD_BYTES

const MAX_PAYLOAD_BYTES = 16777216

Hard framing guard for one exceptionally wide SQL value or SQL statement.

View source

MAX_ROWS_PER_MESSAGE

const MAX_ROWS_PER_MESSAGE = 512

Defines the max rows per message constant used by the minisql protocol constants module.

View source

MAX_SECURE_PLAINTEXT_BYTES

const MAX_SECURE_PLAINTEXT_BYTES = MAX_PAYLOAD_BYTES - SECURE_OVERHEAD_BYTES

Defines the max secure plaintext bytes constant used by the minisql protocol constants module.

View source

PROTOCOL_MAGIC

const PROTOCOL_MAGIC = "MSQL"

Defines the protocol magic identifier used on every MiniSQL wire frame.

View source

PROTOCOL_VERSION

const PROTOCOL_VERSION = 1

Defines the protocol version constant used by the minisql protocol constants module.

View source

SECURE_OVERHEAD_BYTES

const SECURE_OVERHEAD_BYTES = 24

Defines the secure overhead bytes constant used by the minisql protocol constants module.

View source

STATUS_COMMAND

const STATUS_COMMAND = 1

Defines the status command constant used by the minisql protocol constants module.

View source

STATUS_ERROR

const STATUS_ERROR = 3

Defines the status error constant used by the minisql protocol constants module.

View source

STATUS_ROWS

const STATUS_ROWS = 2

Defines the status rows constant used by the minisql protocol constants module.

View source

TARGET_RESULT_FRAME_BYTES

const TARGET_RESULT_FRAME_BYTES = 1048576 - SECURE_OVERHEAD_BYTES

Preferred response payload size used for backpressure-friendly batching.

View source

targetMilestone

function targetMilestone()

Performs the targetMilestone operation for the minisql protocol constants module. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

View source

TYPE_AUTH_BEGIN

const TYPE_AUTH_BEGIN = 5

Defines the type auth begin constant used by the minisql protocol constants module.

View source

TYPE_AUTH_CHALLENGE

const TYPE_AUTH_CHALLENGE = 6

Defines the type auth challenge constant used by the minisql protocol constants module.

View source

TYPE_AUTH_OK

const TYPE_AUTH_OK = 8

Defines the type auth ok constant used by the minisql protocol constants module.

View source

TYPE_AUTH_PROOF

const TYPE_AUTH_PROOF = 7

Defines the type auth proof constant used by the minisql protocol constants module.

View source

TYPE_CANCEL

const TYPE_CANCEL = 9

Administrative request that cooperatively cancels another session's query.

View source

TYPE_CLOSE

const TYPE_CLOSE = 4

Defines the type close constant used by the minisql protocol constants module.

View source

TYPE_ERROR

const TYPE_ERROR = 102

Defines the type error constant used by the minisql protocol constants module.

View source

TYPE_HELLO

const TYPE_HELLO = 1

Defines the type hello constant used by the minisql protocol constants module.

View source

TYPE_PING

const TYPE_PING = 3

Defines the type ping constant used by the minisql protocol constants module.

View source

TYPE_PONG

const TYPE_PONG = 101

Defines the type pong constant used by the minisql protocol constants module.

View source

TYPE_QUERY

const TYPE_QUERY = 2

Defines the type query constant used by the minisql protocol constants module.

View source

TYPE_RESPONSE

const TYPE_RESPONSE = 100

Defines the type response constant used by the minisql protocol constants module.

View source