Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/subztep/sqlitemanager
Unity3D SQLite Manager
https://github.com/subztep/sqlitemanager
data database plugin script sqlite unity unity3d wrapper
Last synced: 3 months ago
JSON representation
Unity3D SQLite Manager
- Host: GitHub
- URL: https://github.com/subztep/sqlitemanager
- Owner: SubZtep
- License: mit
- Created: 2017-09-15T16:47:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-17T12:52:17.000Z (over 6 years ago)
- Last Synced: 2024-08-02T05:21:33.595Z (5 months ago)
- Topics: data, database, plugin, script, sqlite, unity, unity3d, wrapper
- Language: C#
- Size: 1.13 MB
- Stars: 8
- Watchers: 5
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SQLite Manager
==============
[](https://github.com/SubZtep/SQLiteManager/blob/master/LICENSE) [](https://github.com/SubZtep/SQLiteManager/blob/master/README.md) [](http://makeapullrequest.com)
## Welcome
**Adopt Database in Unity3D!** ***SQLite Manager*** make easy to read and update your local data. Use a real database to store environment data, player settings, gameplay variables or whatever is in your mind. Query with SQL from simple schema is much easier than manipulate local textfiles for the same reason.
## Speed Test
****TODO:**** Everything!
## Warning
_Under development, the syntax might change in the future. Although I try to make it safe please use it at your own risk, I haven’t used it in production yet._
Tested only with **Unity 2018.1.1f1 for Windows**, *Linux/Mac/Mobile* support is under blockchain kripto’er. (sic)
## What Is This
A C# wrapper class around Mono’s SQLite functions to make it easier and faster to use.
## Simple Example
Find some basic codes with the plugin. Check out [the test file](https://github.com/SubZtep/SQLiteManager/blob/master/Assets/DemoLand/SQLiteManager/Tests/Editor/SQLiteManagerTest.cs) for more usage example.
- Init database
```csharp
SQLiteManager db;
try {
db = new SQLiteManager("Game.db");
} catch (SqliteException e) {
Debug.Log("Sqlite exception: " + e.Message);
}
```
- Create a class (for examples below)
```csharp
public class User
{
public int UserID { get; set; }
public string Name { get; set; }
}
```
- Run native SQL query
```csharp
using (IDbCommand dbcmd = db.Connection.CreateCommand()) {
dbcmd.CommandText = "INSERT INTO `User` (`UserId`, `Name`) VALUES (1, 'John Doe'), (2, 'Jane Doe');";
dbcmd.ExecuteNonQuery();
}
```
- Get one row
```csharp
User user = db.GetObj(1);
User user = db.GetObj("SELECT * FROM User WHERE UserID = 1");
```
- Get multiple rows
```csharp
List users = db.GetObjList("SELECT * FROM User");
```
## Example Workflow
We gonna store the database connection variable in a static class, the connection will be always available for a command regardless of the scene. All the steps of this workflow already exist on project _SampleScreen_.
1. **Unity Settings**
Use creaky C# version. Go to menu ***_File, Build Settings..., Player Settings..., Other Settings, Scripting Runtime Version_*** and set to recent **.NET 4.x Equivalent**.
2. **Add Container**
To achieve connection container use **[PersistData](https://github.com/SubZtep/PersistData)**. It’s a basic but effective class of mine just handy to store anything in a _HashMap_. Included to this repository.
Create a new empty game object, name it _Persist Data_. In the Inspector window select ***Add Component, Miscellaneous, Persist Data*** for initialising the static class.
3. **Create Database**
There is no plan to create an enormous database admin inside the Unity editor in the near future by me. It would be pointless. There is plenty of 3rd party software for this job. Just find one you like, install it and get ready to create your game **.db** file. The entire database is in a single file, just think about how simple will be its online synchronisation.
I recommend using **[DB Browser for SQLite](http://sqlitebrowser.org/)** open source desktop app. Very straightforward, create a new database, create the schema and insert potential initial records.
Create or open the **Streaming Assets** folder into your *Assets* directory. Copy here your *Game.db* file.
4. **Wake Up Database**
Create a new empty game object, name it _Game Manager_. Create _InitPersistData.cs_ script and connect to the SQLite database at the start.
```csharp
if (!PersistData.Instance.Has(PDKey.Database)) {
SQLiteManager db = null;
UseDatabase udb = GetComponent();
try {
db = new SQLiteManager(udb.GetDatabaseFilePath());
} catch (Exception e) {
udb.UnselectBinary();
Debug.LogException(e);
}
if (db.IsOpen()) {
PersistData.Instance.Set(PDKey.Database, db);
}
}
```
Drop _InitPersistData.cs_ script to the _Game Manager_ Inspector window.
5. **Create Helper Class**
Create _PD.cs_ script and add a shorter connection syntax for SQLite.
```csharp
public static SQLiteManager Database() {
return (SQLiteManager)PersistData.Instance.Get(PDKey.Database);
}
```
Drop _PD.cs_ script to the _Game Manager_ Inspector window.
6. **Additional Component**
If you'd like to test the connection or get disappointed of lack of functions just simply add this component ***Add Component, SQLite Manager, Manage Database***. This component has a chance to become big.
7. **Ready To Use**
At this point, your database should be ready to use without any error message on the Console window. _Game Manager_ Inspector window should look like below.
## Example Code Snippets
- Required Imports
```csharp
using DemoLand.PersistData;
using DemoLand.SQLiteManager;
```
- Set database instance
```csharp
PersistData.Instance.Set("db", db);
```
- Get data
```csharp
string data = ((SQLiteManager)PersistData.Instance.Get("db")).GetObj(1).Name;
```
## Available Methods
Raw public method list, more info in the source code.
- **Connection**
- Connection
- SQLiteManager
- Connect
- Close
- IsOpen
- **Getter Methods**
- GetObj
- GetObjList
- GetTableNames
- GetResultReader
- **Data Manipulation Methods**
- SaveObj
- TruncateTable
- BuildObj
- ColumnExists
- GetParsedSql
## Versioning
The first version will come with the first release, once all the essential functions are there.
[](https://GitHub.com/SubZtep/)