Skip to main content

Module protocol

Module protocol 

Source

Structsยง

RunParams
Parameters for the run function.
StateMachine ๐Ÿ”’

Enumsยง

ExecuteCount ๐Ÿ”’
FetchResult ๐Ÿ”’
PasswordRequestError ๐Ÿ”’
SendRowsEndedReason ๐Ÿ”’
State ๐Ÿ”’

Constantsยง

ABORTED_TXN_MSG ๐Ÿ”’

Functionsยง

authenticate_with_password ๐Ÿ”’
Helper for password-based authentication using AdapterClient and returns an authenticated session.
describe_rows ๐Ÿ”’
extract_oidc_auth_enabled_from_options ๐Ÿ”’
Gets oidc_auth_enabled from options if it exists. Returns options with oidc_auth_enabled extracted and the oidc_auth_enabled value.
fetch_message ๐Ÿ”’
get_authenticator ๐Ÿ”’
is_txn_exit_stmt ๐Ÿ”’
match_handshake
Reports whether the given stream begins with a pgwire handshake.
pad_formats ๐Ÿ”’
parse_option ๐Ÿ”’
Returns the parsed key and value from option of the form --key=value, -c key=value, or -ckey=value. Keys replace - with _. Returns an error if there was some other prefix.
parse_options ๐Ÿ”’
Returns (name, value) session settings pairs from an options value.
portal_exec_message ๐Ÿ”’
request_cleartext_password ๐Ÿ”’
Requests a cleartext password from a connection and returns it if it is valid. Sends an error response in the connection if the password is not valid.
run
Runs a pgwire connection to completion.
split_options ๐Ÿ”’
Splits value by any number of spaces except those preceded by \.

Type Aliasesยง

GetResponse ๐Ÿ”’