SQL(client, gateway)

new SQL(client, gateway)
classes/sql.js, line 23

Creates an instance of SQL.
Parameters:
Name Type Description
client KomadaClient The Komada Client.
gateway SettingGateway The SettingGateway instance which initialized this instance.

Members

readonly client :KomadaClient
classes/sql.js, line 24

The client this SettingsCache was created with.

readonly constants :Object
classes/sql.js, line 106

The constants this instance will use to build the SQL schemas.

readonly defaults :Object
classes/sql.js, line 136

Shortcut for Schema

readonly gateway :SettingGateway
classes/sql.js, line 32

The gateway which initiated this instance.

readonly provider :Resolver
classes/sql.js, line 146

The provider this SettingGateway instance uses for the persistent data operations.

readonly sanitizer :function
classes/sql.js, line 116

Sanitize and prepare the strings for SQL input.

readonly schema :Object
classes/sql.js, line 126

Shortcut for Schema.

Methods

buildSingleSQLSchema(value) → {string}
classes/sql.js, line 46

Generate an automatic SQL schema for a single row.
Parameters:
Name Type Description
value Object The Schema object.
Returns:
string

buildSQLSchema(schema) → {Array.<string>}
classes/sql.js, line 57

Generate an automatic SQL schema for all rows.
Parameters:
Name Type Description
schema any The Schema Object.
Returns:
Array.<string>

deserializer(data)
classes/sql.js, line 79

Deserialize stringified objects.
Parameters:
Name Type Description
data Object The GuildSettings object.

initDeserialize()
classes/sql.js, line 68

Init the deserialization keys for SQL providers.

async updateColumns(schema, defaults, key) → {Promise.<boolean>}
classes/sql.js, line 91

Create/Remove columns from a SQL database, by the current Schema.
Parameters:
Name Type Description
schema Object The Schema object.
defaults Object The Schema object.
key string The key which is updated.
Returns:
Promise.<boolean>

SQL()

new SQL()
classes/sql.js, line 12

SQL driver for compatibility with SQL providers. Do NOT use this directly.

Members

readonly client :KomadaClient
classes/sql.js, line 24

The client this SettingsCache was created with.

readonly constants :Object
classes/sql.js, line 106

The constants this instance will use to build the SQL schemas.

readonly defaults :Object
classes/sql.js, line 136

Shortcut for Schema

readonly gateway :SettingGateway
classes/sql.js, line 32

The gateway which initiated this instance.

readonly provider :Resolver
classes/sql.js, line 146

The provider this SettingGateway instance uses for the persistent data operations.

readonly sanitizer :function
classes/sql.js, line 116

Sanitize and prepare the strings for SQL input.

readonly schema :Object
classes/sql.js, line 126

Shortcut for Schema.

Methods

buildSingleSQLSchema(value) → {string}
classes/sql.js, line 46

Generate an automatic SQL schema for a single row.
Parameters:
Name Type Description
value Object The Schema object.
Returns:
string

buildSQLSchema(schema) → {Array.<string>}
classes/sql.js, line 57

Generate an automatic SQL schema for all rows.
Parameters:
Name Type Description
schema any The Schema Object.
Returns:
Array.<string>

deserializer(data)
classes/sql.js, line 79

Deserialize stringified objects.
Parameters:
Name Type Description
data Object The GuildSettings object.

initDeserialize()
classes/sql.js, line 68

Init the deserialization keys for SQL providers.

async updateColumns(schema, defaults, key) → {Promise.<boolean>}
classes/sql.js, line 91

Create/Remove columns from a SQL database, by the current Schema.
Parameters:
Name Type Description
schema Object The Schema object.
defaults Object The Schema object.
key string The key which is updated.
Returns:
Promise.<boolean>