Db open

From SA-MP Wiki

Jump to: navigation, search

db_open

Image:Farm-Fresh text lowercase.png Note: This function name starts with a lowercase letter.


Image:32px-Circle-style-warning.png

Important
Note

Return type for this function has changed since version 0.3.7 R2.


Description:

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


Parameters:
(name[])
name[]File name of the database


Return Values:

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


Image:32px-Circle-style-warning.png

Important
Notes

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


Example Usage:

new DB:db_handle;
// ...
public OnGameModeInit()
{
	// Create a connection to the database
	if((db_handle = db_open("example.db")) == DB:0)
	{
		// Error
		print("Failed to open a connection to \"example.db\".");
		SendRconCommand("exit");
	}
	else
	{
		// Success
		print("Successfully created a connection to \"example.db\".");
	}
	// ...
	return 1;
}
 
public OnGameModeExit()
{
	// Close the connection to the database
	db_close(db_handle);
	// ...
	return 1;
}

Related Functions

The following functions may be useful, as they are related to this function in one way or another.


  • db_open: Open a connection to an SQLite database
  • db_close: Close the connection to an SQLite database
  • 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_int: Get content of field as an integer with specified ID from current result row
  • db_get_field_float: Get content of field as a float with specified ID from current result row
  • db_get_mem_handle: Get memory handle for an SQLite database that was opened with db_open.
Personal tools
In other languages