DB

Set the global database connection.

Pass an object that's a subclass of SS_Database. This object will be used when DB::query() is called.

Get the global database connection.

Retrieves the schema manager for the current database

Builds a sql query with the specified connection

Retrieves the connector object for the current database

Set an alternative database in a browser cookie, with the cookie lifetime set to the browser session.

This is useful for integration testing on temporary databases.

There is a strict naming convention for temporary databases to avoid abuse:

Get the name of the database in use

Determines if the name is valid, as a security measure against setting arbitrary databases.

Specify connection to a database

Given the database configuration, this method will create the correct subclass of SS_Database.

Set config for a lazy-connected database

Get the named connection config

Returns true if a database connection has been attempted.

In particular, it lets the caller know if we're still so early in the execution pipeline that we haven't even tried to connect to the database yet.

Execute the given SQL query.

Helper function for generating a list of parameter placeholders for the given argument(s)

No description

Execute the given SQL parameterised query with the specified arguments

Execute a complex manipulation on the database.

A manipulation is an array of insert / or update sequences. The keys of the array are table names, and the values are map containing 'command' and 'fields'. Command should be 'insert' or 'update', and fields should be a map of field names to field values, including quotes. The field value can also be a SQL function or similar.

Example:

array(
  // Command: insert
  "table name" => array(
     "command" => "insert",
     "fields" => array(
        "ClassName" => "'MyClass'", // if you're setting a literal, you need to escape and provide quotes
        "Created" => "now()", // alternatively, you can call DB functions
        "ID" => 234,
      ),
     "id" => 234 // an alternative to providing ID in the fields list
   ),

  // Command: update
  "other table" => array(
     "command" => "update",
     "fields" => array(
        "ClassName" => "'MyClass'",
        "LastEdited" => "now()",
      ),
     "where" => "ID = 234",
     "id" => 234 // an alternative to providing a where clause
   ),
)

You'll note that only one command on a given table can be called. That's a limitation of the system that's due to it being written for DataObject::write(), which needs to do a single write on a number of different tables.

Get the autogenerated ID from the previous INSERT query.

Check if the connection to the database is active.

Create the database and connect to it. This can be called if the initial database connection is not successful because the database does not exist.

Create a new table.

Create a new field on a table.

Generate the following table in the database, modifying whatever already exists as necessary.

Generate the given field on the table, modifying whatever already exists as necessary.

Generate the given index in the database, modifying whatever already exists as necessary.

If the given table exists, move it out of the way by renaming it to obsolete(tablename).

See SS_Database->dontRequireField().

Checks a table's integrity and repairs it if necessary.

Return the number of rows affected by the previous operation.

Returns a list of all tables in the database.

The table names will be in lower case.

Get a list of all the fields for the given table.

Returns a map of field name => field spec.

Enable suppression of database messages.

Show a message about database alteration