note Help Needed

This wiki is the result of an ongoing community effort — thank you all for helping!

If you want to provide changes to this page then please click here.

db_open

warning

This function starts with a lowercase letter.

Description

The function is used to open a connection to a SQLite database, which is inside the "/scriptfiles" folder.

Name	Description
const name[]	File name of the database
SQLITE_OPEN:flags = SQLITE_OPEN_READWRITE \| SQLITE_OPEN_CREATE	Permissions / Flags

Returns

Returns index (starting at 1) of the database connection.

Examples

static DB:gDBConnectionHandle;

// ...

public OnGameModeInit()
{
    // ...

    // Create a connection to a database
    gDBConnectionHandle = db_open("example.db");

    // If connection to the database exists
    if (gDBConnectionHandle)
    {
        // Successfully created a connection to the database
        print("Successfully created a connection to database \"example.db\".");
    }
    else
    {
        // Failed to create a connection to the database
        print("Failed to open a connection to database \"example.db\".");
    }

    // ...

    return 1;
}

public OnGameModeExit()
{
    // Close the connection to the database if connection is open
    if (db_close(gDBConnectionHandle))
    {
        // Extra cleanup
        gDBConnectionHandle = DB:0;
    }

    // ...

    return 1;
}

Notes

warning

It will create a new SQLite database file, if there is no SQLite database file with the same file name available. Close your SQLite database connection with db_close!

Related Functions

db_open: Open a connection to an SQLite database
db_close: Close the connection to an SQLite database
db_query: Query an SQLite database
db_free_result: Free result memory from a db_query
db_num_rows: Get the number of rows in a result
db_next_row: Move to the next row
db_num_fields: Get the number of fields in a result
db_field_name: Returns the name of a field at a particular index
db_get_field: Get content of field with specified ID from current result row
db_get_field_assoc: Get content of field with specified name from current result row
db_get_field_int: Get content of field as an integer with specified ID from current result row
db_get_field_assoc_int: Get content of field as an integer with specified name from current result row
db_get_field_float: Get content of field as a float with specified ID from current result row
db_get_field_assoc_float: Get content of field as a float with specified name from current result row
db_get_mem_handle: Get memory handle for an SQLite database that was opened with db_open.
db_get_result_mem_handle: Get memory handle for an SQLite query that was executed with db_query.
db_debug_openfiles: The function gets the number of open database connections for debugging purposes.
db_debug_openresults: The function gets the number of open database results.

Modern SQLite Functions

DB_Open: Open a connection to an SQLite database
DB_Close: Close the connection to an SQLite database
DB_ExecuteQuery: Query an SQLite database
DB_FreeResultSet: Free result memory from a DB_ExecuteQuery
DB_GetRowCount: Get the number of rows in a result
DB_SelectNextRow: Move to the next row
DB_GetFieldCount: Get the number of fields in a result
DB_GetFieldName: Returns the name of a field at a particular index
DB_GetFieldString: Get content of field with specified ID from current result row
DB_GetFieldStringByName: Get content of field with specified name from current result row
DB_GetFieldInt: Get content of field as an integer with specified ID from current result row
DB_GetFieldIntByName: Get content of field as an integer with specified name from current result row
DB_GetFieldFloat: Get content of field as a float with specified ID from current result row
DB_GetFieldFloatByName: Get content of field as a float with specified name from current result row
DB_GetMemHandle: Get memory handle for an SQLite database that was opened with db_open.
DB_GetLegacyDBResult: Get memory handle for an SQLite query that was executed with DB_ExecuteQuery.
DB_GetDatabaseConnectionCount: The function gets the number of open database connections for debugging purposes.
DB_GetDatabaseResultSetCount: The function gets the number of open database results.

Related Resources

SQLite Open Flags