db_query

Datum based handler for all database queries

Holds information regarding inputs, status, and outputs

Vars
affected	How many rows were affected by the query
arguments	An associative list of parameters to be substituted into the statement
connection	The connection being used with this query
in_progress	Is the query currently in progress
item	List of data values populated by NextRow()
last_activity	What was our last activity
last_activity_time	When was our last activity
last_error	What was our last error, if any
last_insert_id	ID of the last inserted row
next_row_to_take	Counter of the next row to take
rows	List of all rows returned
sql	The SQL statement being executed with :parameter placeholders
Procs
Activity	Activity Update Handler
Execute	Main Execution Handler
NextRow	Proc to get the next row in a DB query
run_query	Actual Query Runner
warn_execute	Wrapped for warning on execution

Var Details

var
affected
–

How many rows were affected by the query

var
arguments
–

An associative list of parameters to be substituted into the statement

var
connection
–

The connection being used with this query

var
in_progress
–

Is the query currently in progress

var
item
– /list

List of data values populated by NextRow()

var
last_activity
–

What was our last activity

var
last_activity_time
–

When was our last activity

var
last_error
–

What was our last error, if any

var
last_insert_id
–

ID of the last inserted row

var
next_row_to_take
–

Counter of the next row to take

var
rows
– /list/list

List of all rows returned

var
sql
–

The SQL statement being executed with :parameter placeholders

Proc Details

proc
Activity
(activity)

Activity Update Handler

Sets the last activity text to the argument input, as well as updating the activity time

Arguments:

activity - Last activity text

proc
Execute
(async, log_error)

Main Execution Handler

Invoked by [warn_execute()] This handles query error logging, as well as invoking the actual runner Arguments:

async - Are we running this query asynchronously
log_error - Do we want to log errors this creates? Disable this if you are running sensitive queries where you dont want errors logged in plain text (EG: Auth token stuff)

proc
NextRow
()

Proc to get the next row in a DB query

Cycles item to the next row in the DB query, if multiple were fetched

proc
run_query
(async)

Actual Query Runner

This does the main query with the database and the rust calls themselves

Arguments:

async - Are we running this query asynchronously

proc
warn_execute
(async, log_error)

Wrapped for warning on execution

You should use this proc when running the SQL statement. It will auto inform the user and the online admins if a query fails

Arguments:

async - Are we running this query asynchronously
log_error - Do we want to log errors this creates? Disable this if you are running sensitive queries where you dont want errors logged in plain text (EG: Auth token stuff)

db_query /datum/db_query

Vars

Procs

Var Details

var affected –

var arguments –

var connection –

var in_progress –

var item – /list

var last_activity –

var last_activity_time –

var last_error –

var last_insert_id –

var next_row_to_take –

var rows – /list/list

var sql –

Proc Details

proc Activity(activity)

proc Execute(async, log_error)

proc NextRow()

proc run_query(async)

proc warn_execute(async, log_error)

db_query
/datum/db_query

var
affected
–

var
arguments
–

var
connection
–

var
in_progress
–

var
item
– /list

var
last_activity
–

var
last_activity_time
–

var
last_error
–

var
last_insert_id
–

var
next_row_to_take
–

var
rows
– /list/list

var
sql
–

proc
Activity
(activity)

proc
Execute
(async, log_error)

proc
NextRow
()

proc
run_query
(async)

proc
warn_execute
(async, log_error)