amxmodx/plugins/include/dbi.inc

84 lines
2.7 KiB
PHP
Raw Normal View History

2004-04-02 23:45:26 +00:00
/* SQL Database API
* By the AMX Mod X Development Team
2004-05-28 09:21:11 +00:00
* Notes - Read the comments! Make sure your plugins use
* nice ANSI SQL and don't use database column names like "key"
* otherwise this API will be a nightmare
* Never do error checking with the not operator! This is bad:
* if (!dbi_query())
* You should do:
* ret = dbi_query()
2004-05-30 09:58:51 +00:00
* if (ret < 0)
2004-05-28 09:21:11 +00:00
* This is because DBI functions can and will return negative numbers
* Negative numbers evaluate to "true" in AMX.
2004-04-02 23:45:26 +00:00
*/
#if defined _dbi_included
#endinput
#endif
#define _dbi_included
2004-05-28 09:21:11 +00:00
/* This will return a number equal to or below 0 on failure.
* If it does fail, the error will be mirrored in dbi_error()
* The return value will otherwise be a resource handle, not an
* OK code or cell pointer.
*/
2004-07-18 10:22:55 +00:00
native Sql:dbi_connect(_host[], _user[], _pass[], _dbname[], _error[]="", _maxlength=0);
2004-05-28 09:21:11 +00:00
/* This will do a simple query execution on the SQL server.
2004-05-30 09:58:51 +00:00
* If it fails, it will return a number BELOW ZERO (0)
* If zero, it succeeded with NO RETURN RESULT.
* If greater than zero, make sure to call dbi_free_result() on it!
2004-06-11 21:03:45 +00:00
* The return is a handle to the result set
2004-05-28 09:21:11 +00:00
*/
2004-07-18 10:22:55 +00:00
native Result:dbi_query(Sql:_sql, _query[], {Float,_}:...);
2004-04-02 23:45:26 +00:00
2004-05-28 09:21:11 +00:00
/* Returns 0 on failure or End of Results.
* Advances result pointer by one row.
*/
2004-07-18 10:22:55 +00:00
native dbi_nextrow(Result:_result=1);
2004-04-02 23:45:26 +00:00
2004-05-28 09:21:11 +00:00
/* Gets a field by number. Returns 0 on failure.
* Although internally fields always start from 0,
* This function takes fieldnum starting from 1.
2004-06-11 21:03:45 +00:00
* No extra params: returns int
* One extra param: returns Float: byref
* Two extra param: Stores string with length
2004-05-28 09:21:11 +00:00
*/
2004-07-18 10:22:55 +00:00
native dbi_field(Result:_result, _fieldnum, {Float,_}:... );
2004-05-30 09:58:51 +00:00
2004-06-24 06:59:16 +00:00
/* Gets a field by name. Returns 0 on failure.
2004-06-11 21:03:45 +00:00
* One extra param: returns Float: byref
* Two extra param: Stores string with length
2004-05-30 09:58:51 +00:00
*/
2004-07-18 10:22:55 +00:00
native dbi_result(Result:_result, _field[], {Float,_}:... );
2004-05-30 09:58:51 +00:00
/* Returns the number of rows returned from a query
*/
2004-07-18 10:22:55 +00:00
native dbi_num_rows(Result:_result);
2004-05-30 09:58:51 +00:00
/* Frees memory used by a result handle. Do this or get memory leaks.
*/
2004-07-18 10:22:55 +00:00
native dbi_free_result(Result:_result);
2004-04-02 23:45:26 +00:00
2004-05-28 09:21:11 +00:00
/* Closes a database handle. Internally, it will also
* mark the handle as free, so this particular handle may
* be re-used in the future to save time.
*/
2004-07-18 10:22:55 +00:00
native dbi_close(Sql:_sql);
2004-04-02 23:45:26 +00:00
2004-05-28 09:21:11 +00:00
/* Returns an error message set. For PGSQL and MySQL,
* this is a direct error return from the database handle/API.
* For MSSQL, it returns the last error message found from a
* thrown exception.
*/
2004-07-18 10:22:55 +00:00
native dbi_error(Sql:_sql, _error[], _len);
2004-04-02 23:45:26 +00:00
2004-05-28 09:21:11 +00:00
/* Returns the type of database being used. So far:
* "mysql", "pgsql", "mssql"
*/
native dbi_type(_type[], _len);
2004-07-18 10:22:55 +00:00
/* Wrapper for checking results
* to avoid tag mismatches
*/
native rescode(Result:res);