README
Gaia.DB
Gaia.DB is an online database package.
Usage
Site
/management-accounts.html
Is for list of all accounts.
/userinfo.html?user=xxxx
- user
<string>
Username of an account.
See account's info.
/register.html
Register an account.
Server
Server(path, settings) [Class]
- path
<string>
Database folder path - settings
<object>
Server settings- secret
<string>
Server secret key.
- secret
Create a server.
Server.setup() [AsyncFunction]
Setup the server.
Server.run(app) [AsyncFunction]
- app
<number>/<httpServer>
Run the server. Note: Only run this after you run Server.setup function.
Client
Client(settings) [Class]
- settings
<object>
Client's settings- settings.ip
<string>
Server's IP you want to connect - settings.port
<number>
Server's Port you want to connect - settings.username
<string>
Account's username you try to log as - settings.password
<string>
Account's password you try to log as
- settings.ip
Make client.
Client.setup(callbacks) [Function]
- callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Setup WebSocket connection.
Client.login(callbacks) [Function]
- callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Connect to the server. Note: Only fire this after Client.setup(...)
.
Client.setupAsync() [Function] Setup WebSocket connection.
Client.loginAsync() [Function]
Connect to the server. Note: Only fire this after Client.setup(...)
.
Client.createDB(databaseName, callbacks) [Function]
- databaseName
<string>
Database's name - callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Create a database.
Client.deleteDB(databaseName, callbacks) [Function]
- databaseName
<string>
Database's name - callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Delete a database.
Client.createKey(databaseName, keyName, callbacks) [Function]
- databaseName
<string>
Database's name - keyName
<string>
Key's name - callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Create a key.
Client.deleteKey(databaseName, keyName, callbacks) [Function]
- databaseName
<string>
Database's name - keyName
<string>
Key's name - callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Delete a key.
Client.getKey(databaseName, keyName, keyPath, callbacks) [Function]
- databaseName
<string>
Database's name - keyName
<string>
Key's name - keyPath
<string>
Key's path - callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Get key's value.
Client.setKey(databaseName, keyName, keyValue, keyPath, callbacks) [Function]
- databaseName
<string>
Database's name - keyName
<string>
Key's name - keyValue Key's new value
- keyPath
<string>
- callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Set key's value.
Client.createDBAsync(databaseName) [AsyncFunction]
- databaseName
<string>
Database's name
Create a database.
Client.deleteDBAsync(databaseName) [AsyncFunction]
- databaseName
<string>
Database's name
Delete a database.
Client.createKey(databaseName, keyName) [AsyncFunction]
- databaseName
<string>
Database's name - keyName
<string>
Key's name
Create a key.
Client.deleteKey(databaseName, keyName) [AsyncFunction]
- databaseName
<string>
Database's name - keyName
<string>
Key's name
Delete a key.
Client.getKey(databaseName, keyName, keyPath) [AsyncFunction]
- databaseName
<string>
Database's name - keyName
<string>
Key's name - keyPath
<string>
Key's path
Get key's value.
Client.setKey(databaseName, keyName, keyValue, keyPath) [AsyncFunction]
- databaseName
<string>
Database's name - keyName
<string>
Key's name - keyValue Key's new value
- keyPath
<string>
Set key's value.
Client.Database(databaseName, callbacks) [Function]
- databaseName
<string>
Database Name - callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Create database manager.
Client.Database.createDB(callbacks) [Function]
- callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Create the database.
Client.Database.deleteDB(callbacks) [Function]
- callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Delete the database.
Client.Database.setKey(keyName, keyValue, keyPath, callbacks) [Function]
- keyName
<string>
Key's name - keyValue Key's new value
- keyPath
<string>
- callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Set key's value.
Client.Database.getKey(keyName, keyPath, callbacks) [Function]
- keyName
<string>
Key's name - keyPath
<string>
- callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Get key's value.
Client.Database.deleteKey(keyName, callbacks) [Function]
- keyName
<string>
Key's name - callbacks
<object>
- success
<function>
Success callback - fail
<function>
Fail callback
- success
Delete a key.
Client.Database.createDBAsync() [ASyncFunction]
Create the database.
Client.Database.deleteDBAsync() [AsyncFunction]
Delete the database.
Client.Database.setKeyAsync(keyName, keyValue, keyPath) [AsyncFunction]
- keyName
<string>
Key's name - keyValue Key's new value
- keyPath
<string>
Set key's value.
Client.Database.getKeyAsync(keyName, keyPath) [AsyncFunction]
- keyName
<string>
Key's name - keyPath
<string>
Get key's value.
Client.Database.deleteKeyAsync(keyName) [AsyncFunction]
- keyName
<string>
Key's name
Delete a key.
Client.on(event, callback) [Function]
- event
<string>
Event's name - callback
<function>
Register a callback to an event. You can check all events in events.txt
.
Client.once(event, callback) [Function]
- event
<string>
Event's name - callback
<function>
Register a callback to an event but only fired once. You can check all events in events.txt
.
Client.off(event,id) [Function]
- event
<string>
Event's name - id Callback's ID
Delete a callback from an event. You can check all events in events.txt
.
Example
Check test folder.
Bugs
Changelogs
v1.2.2
- Fixed cannot login to the server after created an account.
v1.2.3
- Updated socket.io and socket.io-client to new version.
v2.0.0
- Added site plugin.
v2.1.0
- Added async functions those return promises.
v2.1.1
- Added a few functions explanation into readme.
v2.1.2
- Updated README.md
v2.1.3
- Fixed userinfo.html
v2.1.4
- Upgraded userinfo.html
v2.1.5 ~ v2.1.8
- Fixed getKey, setKey, createKey and deleteKey.
- Fixed async functions.
- Added Header.
v2.1.9
- Renamed all async functions.
- Fixed getKey for not throwing error.
v2.2.0
- Fixed name typo.
v2.2.1
- Fixed createKey for not throwing error when a key is already exists.
Developers
- Gaia#7541 [Discord] = Back-End/Markdown/Front-End
- RaeedDoesGaming#6489 [Discord] = Front-End
- Odd Stranger#7957 [Discord] = Back-End/Markdown
Support Us
Special Thanks To
- Microsoft
- aurdev#0001 (Discord)
- Ryan Dahl
- Brendan Eich
- FrostyTheDumDum (Discord)
Plugins
- Site [https://localhost:port/]
License
MIT