Garry's Mod Wiki

Home / sql

sql

The SQL library allows you to access powerful database software included with Garry's Mod. It is the preferred and fastest method of storing large amounts of data. The database is located in sv.db serverside and cl.db clientside, both in the Garry's Mod base folder. SQL is a whole scripting language in itself although relatively simple, it's something you'll need to read up on before using this library.

Example of using sql.

-- Creating a table sql.Query("CREATE TABLE my_db_table( id NUMBER , name TEXT )" ) -- Inserting a value to the table sql.Query("INSERT INTO my_db_table( id , name ) VALUES( 1 , 'First') ") -- Printing the tables data PrintTable( sql.Query("SELECT * FROM my_db_table ") ) -- Deleting the table sql.Query("DROP TABLE my_db_table")

Known GMod SQLite settings:

  • Temp files are stored in memory (SQLITE_TEMP_STORE = 3)
  • No ATTACH and DETACH operations (SQLITE_OMIT_ATTACH = 1)
  • No Virtual Tables (SQLITE_OMIT_VIRTUALTABLE = 1)
  • No VACUUM operation (SQLITE_OMIT_VACUUM = 1)
  • No LIMIT and ORDER BY clauses in DELETE and UPDATE statements (SQLITE_ENABLE_UPDATE_DELETE_LIMIT)

Methods

sql.Begin()
Tells the engine a set of queries is coming. Will wait until sql. Commit is called to run them. This is most useful when you run more than 100+ queries. This is equivalent to : sql. Query( "BEGIN;" )
sql.Commit()
Tells the engine to execute a series of queries queued for execution, must be preceded by sql. Begin. This is equivalent to sql. Query( "COMMIT;" ).
boolean sql.IndexExists( string indexName )
Returns true if the index with the specified name exists.
string sql.LastError()
Returns the last error from a SQLite query.
table or boolean or nil sql.Query( string query )
Performs a query on the local SQLite database, returns a table as result set, nil if result is empty and false on error. To run SQL queries with this function safely, it is crucial to ensure that the concatenated variables in the query string are safe to avoid vulnerabilities like SQL injections. For this, it is recommended to use the sql. SQLStr, which allows arguments to be escaped correctly.
table sql.QueryRow( string query, number row = 1 )
Performs the sql. Query and returns the n'th row. This function is equivalent to safely returning sql. Query(query)[row]
table or boolean sql.QueryTyped( string query, ... )
Performs a query on the local SQLite database with proper type handling and parameter binding, returns a table as result set, empty table if no results, and false on error. Unlike sql. Query, this function properly handles SQLite data types and allows safe parameter binding to prevent SQL injection attacks. This function only executes a single SQL statement, unlike sql. Query which can execute multiple statements separated by semicolons. Large INTEGER values (beyond ±9,007,199,254,740,991) are returned as strings to preserve exact values. This is because Lua represents all numbers as doubles, which lose precision for integers larger than 2⁵³-1. Returning them as strings prevents data corruption from rounding errors.
string sql.QueryValue( string query )
Performs the query like sql. QueryRow, but returns the first value found.
string sql.SQLStr( string string, boolean bNoQuotes = false )
Escapes dangerous characters and symbols from user input used in an SQLite SQL Query. Do not use this function with external database engines such as MySQL. MySQL and SQLite use different escape sequences that are incompatible with each other! Escaping strings with inadequate functions is dangerous and will lead to SQL injection vulnerabilities.
boolean sql.TableExists( string tableName )
Returns true if the table with the specified name exists.

Account Management

Special Pages

Wiki List