Skip to content

Functions

imshooter edited this page Oct 24, 2026 · 1 revision

Every native and callback of mysql.inc, by subject.

Connections

Function Description
MySQL_Connect Connect to a database.
MySQL_ConnectFile Connect to a database with the settings of a file.
MySQL_Close Close a handle after running every query still waiting.
MySQL_IsConnected Whether the connection of the ordered queries is open.
MySQL_GetConnectionErrno The error of the last time the handle failed to connect.
MySQL_GetConnectionError The message of the last time the handle failed to connect.
MySQL_GetConnectionTLS The TLS version and cipher of the connection of the ordered queries.
MySQL_GetPendingCount How many queries of a handle wait or run.
MySQL_GetStats What a handle did since it connected.

Queries

Function Description
MySQL_Send Send a query that needs no answer.
MySQL_Query Send a query, and call a public with context when it is done.
MySQL_ParallelQuery Send a query that any connection of the pool may run, out of order with the rest.
MySQL_Run Run a query and wait for it, after the queries sent before it.
MySQL_Format Format a query into an array.

Queries built in pieces

Function Description
MySQL_CreateQuery Start a query to build a piece at a time.
MySQL_AppendQuery Add a piece to a query.
MySQL_TrimQuery Remove characters from the end of a query, such as the comma after the last row.
MySQL_GetQueryLength The length of a query being built.
MySQL_ClearQuery Empty a query being built, to build another in it.
MySQL_SendQuery Send a query built in pieces, and forget it, also when it is refused.
MySQL_RunQuery Run a query built in pieces and wait for it, as MySQL_Run does, and forget it.
MySQL_DestroyQuery Forget a query being built without sending it.

Prepared statements

Function Description
MySQL_Prepare Prepare a statement, with a specifier for each value.
MySQL_Execute Run a statement once, after the queries sent before it.
MySQL_RunStatement Run a statement once and wait for it, as MySQL_Run does.
MySQL_CreateBatch Start a batch of rows for a statement.
MySQL_AddRow Add a row of values to a batch. The values are copied at once.
MySQL_GetBatchRows The rows added to a batch.
MySQL_ExecuteBatch Send the rows of a batch after the queries sent before it, and forget it, also when it is refused.
MySQL_RunBatch Send the rows of a batch and wait for them, as MySQL_Run does, and forget it.
MySQL_DestroyBatch Forget a batch without sending it.
MySQL_CloseStatement Close a statement after what was sent before it, and forget its batches.

Results

Function Description
MySQL_GetErrno The error of the query read.
MySQL_GetError The message of the error of the query read.
MySQL_GetQuery The text of the query read.
MySQL_GetQueryTime Milliseconds the query read took to run, without the time it waited.
MySQL_GetResultSetCount How many statements of the query read gave a result.
MySQL_SelectResultSet Choose which statement of the query read the natives read.
MySQL_GetRowCount How many rows the result read has.
MySQL_GetFieldCount How many fields the result read has.
MySQL_GetFieldName The name of a field of the result read.
MySQL_GetFieldIndex The index of a field of the result read, found by its name in any case.
MySQL_GetAffectedRows Rows the statement read changed, or the rows it returned.
MySQL_GetInsertID The id AUTO_INCREMENT gave the row the statement read inserted.
MySQL_GetWarningCount Warnings the statement read gave.

Cells

Function Description
MySQL_IsNull Whether a cell of the result read is NULL.
MySQL_GetInt A cell of the result read as an integer, 0 when it is NULL.
MySQL_GetFloat A cell of the result read as a float, 0.0 when it is NULL.
MySQL_GetBool A cell of the result read as a bool, false when it is NULL.
MySQL_GetString A cell of the result read as a string.
MySQL_GetRow Read the cells of a row into variables in one call, field after field.

Kept results

Function Description
MySQL_KeepResult Keep the result read after its public returns.
MySQL_UseResult Read a kept result, or go back to the result of the public with INVALID_RESULT_ID.
MySQL_DestroyResult Free a kept result.

JSON cells

Function Description
MySQL_GetJSONType The type of a value of a JSON cell.
MySQL_GetJSONCount How many members an object of a JSON cell has, or how many elements an array has.
MySQL_GetJSONKey The name of a member of an object of a JSON cell, by its position.
MySQL_GetJSONInt A value of a JSON cell as an integer.
MySQL_GetJSONFloat A value of a JSON cell as a float.
MySQL_GetJSONBool A value of a JSON cell as a bool.
MySQL_GetJSONString A value of a JSON cell as a string. An object or an array is written as JSON.

Passwords

Function Description
MySQL_HashArgon2 Hash a password with Argon2id on a thread of the component, and call a public with context and the hash.
MySQL_HashBcrypt Hash a password with bcrypt, as $2b$, on a thread of the component, and call a public with context and the hash.
MySQL_VerifyPassword Verify a password against an Argon2 or bcrypt hash on a thread of the component, and call a public with context and whether they match.

Callbacks

Function Description
OnMySQLError A query failed, before its public is called.

Clone this wiki locally