Resource:Datastore: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Resource page}} DataStore allows you to store data (string/table) to a specific key in the database table. All you have to do is enter your database information in settings....")
 
No edit summary
 
Line 12: Line 12:
This function returns the database, if there is one at least.
This function returns the database, if there is one at least.
<syntaxhighlight lang="lua">exports['datastore']:getDatabase()</syntaxhighlight>  
<syntaxhighlight lang="lua">exports['datastore']:getDatabase()</syntaxhighlight>  
===Returns===
===Returns===
Returns the database connection if one was connected.
Returns the database connection if one was connected.
Line 19: Line 20:
<section name="Server" class="server" show="true">
<section name="Server" class="server" show="true">
This function stores data into a specific key in the connected database table.
This function stores data into a specific key in the connected database table.
<syntaxhighlight lang="lua">exports['datastore']:storeData(string key, string/table value)</syntaxhighlight>  
<syntaxhighlight lang="lua">exports['datastore']:storeData(string key, string/table value, string theTable)</syntaxhighlight>  
 
===Required Arguments===
===Required Arguments===
*'''string''' key: Key that the data is gonna be stored in
*'''key''': Key that the data is gonna be stored in
*'''string/table''' value: Data to be stored in the key '''(tables are automatically stored as a string)'''
*'''value''': Data to be stored in the key '''(tables are automatically stored as a string)'''
 
===Optional Arguments===
*'''theTable''': the table that you're wanting to store the data in '''(the data is stored in the default table if you didn't enter the specific table)''' - only works from version 1.1
 
===Returns===
===Returns===
Returns true if the data was stored successfully.
Returns true if the data was stored successfully.
Line 30: Line 36:
<section name="Server" class="server" show="true">
<section name="Server" class="server" show="true">
This function gets the data stored in a specific key.
This function gets the data stored in a specific key.
<syntaxhighlight lang="lua">exports['datastore']:getData(string key)</syntaxhighlight>  
<syntaxhighlight lang="lua">exports['datastore']:getData(string key, string theTable)</syntaxhighlight>  
 
===Required Arguments===  
===Required Arguments===  
*'''string''' key: Key that you would like to receive the data of.
*'''key''': Key that you would like to receive the data of.
 
===Optional Arguments===
*'''theTable''': the table that you're wanting to get the data from '''(if no table was entered here then it automatically looks in the default table)''' - only works from version 1.1
 
===Returns===
===Returns===
Returns the data that was stored in the key if found. ''(converted tables to strings are automatically returned as tables)''
Returns the data that was stored in the key if found. ''(converted tables to strings are automatically returned as tables)''
Line 40: Line 51:
<section name="Server" class="server" show="true">
<section name="Server" class="server" show="true">
This function gets all the keys and data stored in the connected database table.
This function gets all the keys and data stored in the connected database table.
<syntaxhighlight lang="lua">exports['datastore']:getAllData()</syntaxhighlight>  
<syntaxhighlight lang="lua">exports['datastore']:getAllData(string theTable)</syntaxhighlight>  
 
===Optional Arguments===
*'''theTable''': the table that you're wanting to get the data from '''(if no table was entered here then it automatically looks in the default table)''' - only works from version 1.1
 
===Returns===
*'''Version 1.0''': Returns table of all the data received from the connected database table. Key names being the index value, value being the data of the key.
*'''From Version 1.1 and forward''': Returns table of all the data received from the selected database table (default table if none was entered). Indexed numerically, value being a table of the key and value
</section>
 
====removeData====
<section name="Server" class="server" show="true">
This function removes the data stored in a specific key. - Only works from version 1.1
<syntaxhighlight lang="lua">exports['datastore']:removeData(string key, string theTable)</syntaxhighlight>
 
===Required Arguments===
*'''key''': Key that you would like to remove the data of.
 
===Optional Arguments===
*'''theTable''': the table that you're wanting to remove the data from '''(if no table was entered here then it automatically removes from the default table)'''
 
===Returns===
===Returns===
Returns table of all the data received from the connected database table. Key names being the index value, value being the data of the key.
Returns true if successful
</section>
</section>


==See Also==
==See Also==
'''Resource:''' https://community.multitheftauto.com/?p=resources&s=details&id=17541
'''Resource:''' https://community.multitheftauto.com/?p=resources&s=details&id=17541

Latest revision as of 10:09, 25 December 2020

DataStore allows you to store data (string/table) to a specific key in the database table. All you have to do is enter your database information in settings.lua('sqlite' or 'mysql') and once connected you can use the datastore exported functions to store and/or get data from the db table. Very useful for beginner developers who lack experience with MySQL/SQLite.

Overview

Fairly easy to use.

Exported functions

getDatabase

Click to collapse [-]
Server

This function returns the database, if there is one at least. 

exports['datastore']:getDatabase()

Returns

Returns the database connection if one was connected.

storeData

Click to collapse [-]
Server

This function stores data into a specific key in the connected database table. 

exports['datastore']:storeData(string key, string/table value, string theTable)

Required Arguments

  • key: Key that the data is gonna be stored in
  • value: Data to be stored in the key (tables are automatically stored as a string)

Optional Arguments

  • theTable: the table that you're wanting to store the data in (the data is stored in the default table if you didn't enter the specific table) - only works from version 1.1

Returns

Returns true if the data was stored successfully.

getData

Click to collapse [-]
Server

This function gets the data stored in a specific key. 

exports['datastore']:getData(string key, string theTable)

Required Arguments

  • key: Key that you would like to receive the data of.

Optional Arguments

  • theTable: the table that you're wanting to get the data from (if no table was entered here then it automatically looks in the default table) - only works from version 1.1

Returns

Returns the data that was stored in the key if found. (converted tables to strings are automatically returned as tables)

getAllData

Click to collapse [-]
Server

This function gets all the keys and data stored in the connected database table. 

exports['datastore']:getAllData(string theTable)

Optional Arguments

  • theTable: the table that you're wanting to get the data from (if no table was entered here then it automatically looks in the default table) - only works from version 1.1

Returns

  • Version 1.0: Returns table of all the data received from the connected database table. Key names being the index value, value being the data of the key.
  • From Version 1.1 and forward: Returns table of all the data received from the selected database table (default table if none was entered). Indexed numerically, value being a table of the key and value

removeData

Click to collapse [-]
Server

This function removes the data stored in a specific key. - Only works from version 1.1 

exports['datastore']:removeData(string key, string theTable)

Required Arguments

  • key: Key that you would like to remove the data of.

Optional Arguments

  • theTable: the table that you're wanting to remove the data from (if no table was entered here then it automatically removes from the default table)

Returns

Returns true if successful

See Also

Resource: https://community.multitheftauto.com/?p=resources&s=details&id=17541

Retrieved from "https://wiki.multitheftauto.com/wiki/Resource:Datastore?oldid=68091"