While each Modus SDK offers similar capabilities, the APIs and usage may vary between languages.Modus MySQL APIs documentation is available on the following pages:
The APIs in the mysql namespace are below, organized by category.
We’re constantly introducing new APIs through ongoing development with early
users. Please open an issue if
you have ideas on what would make Modus even more powerful for your next app!
Execute a SQL statement against a MySQL database, without any data returned. Use
this for insert, update, or delete operations, or for other SQL statements that
don’t return data.
The execute function is for operations that don’t return data. However, some
insert/update/delete operations may still return data. In these cases, you can
use the queryScalar or query functions instead.
Copy
Ask AI
function execute( connection: string, statement: string, params?: Params,): Response
SQL statement containing the query or mutation operation to execute.
While it’s possible to directly include parameter values into your SQL
statement, it’s highly recommended to pass a Params object
instead. This can help to protect against injection attacks and other security
vulnerabilities.
Execute a SQL statement against a MySQL database, returning a set of rows. In
the results, each row converts to an object of type T, with fields matching
the column names.
Copy
Ask AI
function query<T>( connection: string, statement: string, params?: Params,): QueryResponse<T>
Type of object to use for the data returned from the query. This can be any
type, including a custom type defined in your project. It should match the shape
of the row returned from the SQL query.
Define custom types in the app’s source code. In AssemblyScript, create classes
decorated with @json.All types, including classes, base classes, and field types must be JSON
serializable. You can also use built-in types such as strings, numbers, arrays,
and maps.If working with MySQL’s point data type, you can use a Point or
Location object to represent the data.
SQL statement containing the query or mutation operation to execute.
While it’s possible to directly include parameter values into your SQL
statement, it’s highly recommended to pass a Params object
instead. This can help to protect against injection attacks and other security
vulnerabilities.
Execute a SQL statement against a MySQL database, returning a single scalar
value. For example, the result could be a count, sum, or average, or it could be
an identifier.
Copy
Ask AI
function queryScalar<T>( connection: string, statement: string, params?: Params,): ScalarResponse<T>
Type of object to use for the data returned from the query. This should
generally be a scalar data type, such as a number or string. It should match
the type of the data returned from the SQL query.
SQL statement containing the query or mutation operation to execute.
While it’s possible to directly include parameter values into your SQL
statement, it’s highly recommended to pass a Params object
instead. This can help to protect against injection attacks and other security
vulnerabilities.
Represents a location on Earth, having longitude and latitude coordinates.Correctly serializes to and from MySQL’s point type, in (longitude, latitude)
order.
This class is identical to the Point class, but uses different field
names.
A container for parameters to include with a SQL operation.To use this feature, create a new Params object and call the push method for
each parameter you want to include. Then pass the object to the execute,
query, or queryScalar function along with your SQL statement.
Copy
Ask AI
class Params { push<T>(value: T): void toJSON(): string}
Push a parameter value into the list included with the SQL operation. The
sequence of calls to push determines the order of the parameters in the SQL
statement. This corresponds to the order of the ? placeholders or $1, $2,
etc.
The value of the parameter to include in the SQL operation.The value can be of any type that’s JSON serializable, including strings,
numbers, boolean values, arrays, maps, and custom objects decorated with
@json, as long as the database supports it.
If working with MySQL’s Point data type, you can either pass separate
parameters for the coordinates and use a point() function in the SQL
statement, or you can pass a Point or Location
object as a single parameter.
Serializes the parameters to a JSON string for inclusion in the SQL operation.
The SDK functions call this automatically when you pass a Params object. You
typically don’t need to call it directly.