File-src-minisql-server-server-ml-618711306.md

src/minisql/server/server.ml

Home · Files

Provides minisql server server facilities for this project.

Package: minisql.server.server

Reachable from entry: yes

Imports

• minisql/common/version.ml as version → src/minisql/common/version.ml
• minisql/server/listener.ml as listener → src/minisql/server/listener.ml

Declarations

componentName

function componentName()

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

View source

isImplemented

function isImplemented()

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

View source

m0SelfTestLine

function m0SelfTestLine()

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

View source

serveAuthenticatedConcurrent

function serveAuthenticatedConcurrent(databasePath, port, maximumClients, maximumRequests)

Serves authenticated concurrent using the supplied inputs. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.

View source

serveAuthenticatedConcurrentWithLockWait

function serveAuthenticatedConcurrentWithLockWait(databasePath, port, maximumClients, maximumRequests, lockWaitMs)

Serves authenticated loopback clients using the configured lock wait timeout.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.

View source

serveAuthenticatedOne

function serveAuthenticatedOne(databasePath, port, maximumRequests)

Serves authenticated one using the supplied inputs. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.

View source

serveConcurrent

function serveConcurrent(databasePath, port, maximumClients, maximumRequests)

Serves concurrent using the supplied inputs. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.

View source

serveConcurrentFenced

function serveConcurrentFenced(databasePath, port, maximumClients, maximumRequests, leasePath, epoch, nodeId, clockSkewMs)

Serves a controller-fenced writable primary on loopback.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
leasePath	dynamic	—	Path associated with lease.
epoch	dynamic	—	epoch value consumed by this operation.
nodeId	dynamic	—	Identifier of node.
clockSkewMs	dynamic	—	clockSkewMs value consumed by this operation.

View source

serveConcurrentWithLockWait

function serveConcurrentWithLockWait(databasePath, port, maximumClients, maximumRequests, lockWaitMs)

Serves trusted clients using the configured logical-lock wait timeout.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.

View source

serveConcurrentWithOperationalLimits

function serveConcurrentWithOperationalLimits(databasePath, port, maximumClients, maximumRequests, lockWaitMs, checkpointWalBytes, bufferPoolBytes, queryMemoryBytes, maxStatementBytes, maxFrameBytes, maxResultRows, maxResultBytes, idleTimeoutMs, processMemoryBytes, temporaryStorageBytes, slowQueryMs)

Serves trusted clients with all production runtime and hard result limits.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.
checkpointWalBytes	dynamic	—	checkpointWalBytes value consumed by this operation.
bufferPoolBytes	dynamic	—	bufferPoolBytes value consumed by this operation.
queryMemoryBytes	dynamic	—	queryMemoryBytes value consumed by this operation.
maxStatementBytes	dynamic	—	maxStatementBytes value consumed by this operation.
maxFrameBytes	dynamic	—	maxFrameBytes value consumed by this operation.
maxResultRows	dynamic	—	maxResultRows value consumed by this operation.
maxResultBytes	dynamic	—	maxResultBytes value consumed by this operation.
idleTimeoutMs	dynamic	—	idleTimeoutMs value consumed by this operation.
processMemoryBytes	dynamic	—	processMemoryBytes value consumed by this operation.
temporaryStorageBytes	dynamic	—	temporaryStorageBytes value consumed by this operation.
slowQueryMs	dynamic	—	slowQueryMs value consumed by this operation.

View source

serveConcurrentWithRuntime

function serveConcurrentWithRuntime(databasePath, port, maximumClients, maximumRequests, lockWaitMs, checkpointWalBytes, bufferPoolBytes, queryMemoryBytes)

Serves trusted clients with all configured runtime durability thresholds.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.
checkpointWalBytes	dynamic	—	checkpointWalBytes value consumed by this operation.
bufferPoolBytes	dynamic	—	bufferPoolBytes value consumed by this operation.
queryMemoryBytes	dynamic	—	queryMemoryBytes value consumed by this operation.

View source

serveOne

function serveOne(databasePath, port, maximumRequests)

Serves one using the supplied inputs. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.

View source

serveSecureAddress

function serveSecureAddress(databasePath, address, port, maximumClients, maximumRequests)

Serves secure address using the supplied inputs. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
address	dynamic	—	address value consumed by this operation.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.

View source

serveSecureAddressWithLockWait

function serveSecureAddressWithLockWait(databasePath, address, port, maximumClients, maximumRequests, lockWaitMs)

Serves authenticated address clients using the configured lock wait timeout.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
address	dynamic	—	address value consumed by this operation.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.

View source

serveSecureAddressWithOperationalLimits

function serveSecureAddressWithOperationalLimits(databasePath, address, port, maximumClients, maximumRequests, lockWaitMs, checkpointWalBytes, bufferPoolBytes, queryMemoryBytes, maxStatementBytes, maxFrameBytes, maxResultRows, maxResultBytes, idleTimeoutMs, processMemoryBytes, temporaryStorageBytes, slowQueryMs)

Serves authenticated clients with all production runtime and hard result limits.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
address	dynamic	—	address value consumed by this operation.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.
checkpointWalBytes	dynamic	—	checkpointWalBytes value consumed by this operation.
bufferPoolBytes	dynamic	—	bufferPoolBytes value consumed by this operation.
queryMemoryBytes	dynamic	—	queryMemoryBytes value consumed by this operation.
maxStatementBytes	dynamic	—	maxStatementBytes value consumed by this operation.
maxFrameBytes	dynamic	—	maxFrameBytes value consumed by this operation.
maxResultRows	dynamic	—	maxResultRows value consumed by this operation.
maxResultBytes	dynamic	—	maxResultBytes value consumed by this operation.
idleTimeoutMs	dynamic	—	idleTimeoutMs value consumed by this operation.
processMemoryBytes	dynamic	—	processMemoryBytes value consumed by this operation.
temporaryStorageBytes	dynamic	—	temporaryStorageBytes value consumed by this operation.
slowQueryMs	dynamic	—	slowQueryMs value consumed by this operation.

View source

serveSecureAddressWithRuntime

function serveSecureAddressWithRuntime(databasePath, address, port, maximumClients, maximumRequests, lockWaitMs, checkpointWalBytes, bufferPoolBytes, queryMemoryBytes)

Serves authenticated clients with configured lock and WAL thresholds.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
address	dynamic	—	address value consumed by this operation.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.
checkpointWalBytes	dynamic	—	checkpointWalBytes value consumed by this operation.
bufferPoolBytes	dynamic	—	bufferPoolBytes value consumed by this operation.
queryMemoryBytes	dynamic	—	queryMemoryBytes value consumed by this operation.

View source

serveStandbyConcurrent

function serveStandbyConcurrent(databasePath, port, maximumClients, maximumRequests)

Serves standby concurrent using the supplied inputs. Returns the computed value or operation status. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.

View source

serveStandbyConcurrentWithLockWait

function serveStandbyConcurrentWithLockWait(databasePath, port, maximumClients, maximumRequests, lockWaitMs)

Serves standby clients using the configured logical-lock wait timeout.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.

View source

serveStandbyConcurrentWithOperationalLimits

function serveStandbyConcurrentWithOperationalLimits(databasePath, port, maximumClients, maximumRequests, lockWaitMs, checkpointWalBytes, bufferPoolBytes, queryMemoryBytes, maxStatementBytes, maxFrameBytes, maxResultRows, maxResultBytes, idleTimeoutMs, processMemoryBytes, temporaryStorageBytes, slowQueryMs)

Serves standby clients with all production runtime and hard result limits.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.
checkpointWalBytes	dynamic	—	checkpointWalBytes value consumed by this operation.
bufferPoolBytes	dynamic	—	bufferPoolBytes value consumed by this operation.
queryMemoryBytes	dynamic	—	queryMemoryBytes value consumed by this operation.
maxStatementBytes	dynamic	—	maxStatementBytes value consumed by this operation.
maxFrameBytes	dynamic	—	maxFrameBytes value consumed by this operation.
maxResultRows	dynamic	—	maxResultRows value consumed by this operation.
maxResultBytes	dynamic	—	maxResultBytes value consumed by this operation.
idleTimeoutMs	dynamic	—	idleTimeoutMs value consumed by this operation.
processMemoryBytes	dynamic	—	processMemoryBytes value consumed by this operation.
temporaryStorageBytes	dynamic	—	temporaryStorageBytes value consumed by this operation.
slowQueryMs	dynamic	—	slowQueryMs value consumed by this operation.

View source

serveStandbyConcurrentWithRuntime

function serveStandbyConcurrentWithRuntime(databasePath, port, maximumClients, maximumRequests, lockWaitMs, checkpointWalBytes, bufferPoolBytes, queryMemoryBytes)

Serves standby clients with configured lock and WAL thresholds.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.
checkpointWalBytes	dynamic	—	checkpointWalBytes value consumed by this operation.
bufferPoolBytes	dynamic	—	bufferPoolBytes value consumed by this operation.
queryMemoryBytes	dynamic	—	queryMemoryBytes value consumed by this operation.

View source

serveTlsAddress

function serveTlsAddress(databasePath, address, port, maximumClients, maximumRequests, certificateReference)

Serves authenticated MiniSQL over native TLS 1.3 using a store or PFX certificate.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
address	dynamic	—	address value consumed by this operation.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
certificateReference	dynamic	—	certificateReference value consumed by this operation.

View source

serveTlsAddressWithLockWait

function serveTlsAddressWithLockWait(databasePath, address, port, maximumClients, maximumRequests, certificateReference, lockWaitMs)

Serves native TLS clients using the configured logical-lock wait timeout.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
address	dynamic	—	address value consumed by this operation.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
certificateReference	dynamic	—	certificateReference value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.

View source

serveTlsAddressWithOperationalLimits

function serveTlsAddressWithOperationalLimits(databasePath, address, port, maximumClients, maximumRequests, certificateReference, lockWaitMs, checkpointWalBytes, bufferPoolBytes, queryMemoryBytes, maxStatementBytes, maxFrameBytes, maxResultRows, maxResultBytes, idleTimeoutMs, processMemoryBytes, temporaryStorageBytes, slowQueryMs)

Serves native TLS clients with all production runtime and hard result limits.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
address	dynamic	—	address value consumed by this operation.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
certificateReference	dynamic	—	certificateReference value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.
checkpointWalBytes	dynamic	—	checkpointWalBytes value consumed by this operation.
bufferPoolBytes	dynamic	—	bufferPoolBytes value consumed by this operation.
queryMemoryBytes	dynamic	—	queryMemoryBytes value consumed by this operation.
maxStatementBytes	dynamic	—	maxStatementBytes value consumed by this operation.
maxFrameBytes	dynamic	—	maxFrameBytes value consumed by this operation.
maxResultRows	dynamic	—	maxResultRows value consumed by this operation.
maxResultBytes	dynamic	—	maxResultBytes value consumed by this operation.
idleTimeoutMs	dynamic	—	idleTimeoutMs value consumed by this operation.
processMemoryBytes	dynamic	—	processMemoryBytes value consumed by this operation.
temporaryStorageBytes	dynamic	—	temporaryStorageBytes value consumed by this operation.
slowQueryMs	dynamic	—	slowQueryMs value consumed by this operation.

View source

serveTlsAddressWithPassword

function serveTlsAddressWithPassword(databasePath, address, port, maximumClients, maximumRequests, certificateReference, passwordBytes)

Serves native TLS with an explicit in-memory PFX password for controlled callers.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
address	dynamic	—	address value consumed by this operation.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
certificateReference	dynamic	—	certificateReference value consumed by this operation.
passwordBytes	dynamic	—	passwordBytes value consumed by this operation.

View source

serveTlsAddressWithReadyFile

function serveTlsAddressWithReadyFile(databasePath, address, port, maximumClients, maximumRequests, certificateReference, readyPath)

Serves bounded native TLS and publishes a readiness marker for integration tests.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
address	dynamic	—	address value consumed by this operation.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
certificateReference	dynamic	—	certificateReference value consumed by this operation.
readyPath	dynamic	—	Path associated with ready.

View source

serveTlsAddressWithRuntime

function serveTlsAddressWithRuntime(databasePath, address, port, maximumClients, maximumRequests, certificateReference, lockWaitMs, checkpointWalBytes, bufferPoolBytes, queryMemoryBytes)

Serves native TLS clients with configured lock and WAL thresholds.

Parameter	Type	Default	Description
databasePath	dynamic	—	Path associated with database.
address	dynamic	—	address value consumed by this operation.
port	dynamic	—	port value consumed by this operation.
maximumClients	dynamic	—	maximumClients value consumed by this operation.
maximumRequests	dynamic	—	maximumRequests value consumed by this operation.
certificateReference	dynamic	—	certificateReference value consumed by this operation.
lockWaitMs	dynamic	—	lockWaitMs value consumed by this operation.
checkpointWalBytes	dynamic	—	checkpointWalBytes value consumed by this operation.
bufferPoolBytes	dynamic	—	bufferPoolBytes value consumed by this operation.
queryMemoryBytes	dynamic	—	queryMemoryBytes value consumed by this operation.

View source

start

function start(configPath)

Implements start for this module. Returns its result or propagates a structured error from validation or a dependency. Any side effects are limited to the explicitly invoked dependencies.

Parameter	Type	Default	Description
configPath	dynamic	—	Path associated with config.

View source

targetMilestone

function targetMilestone()

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

View source

versionLine

function versionLine()

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

View source