https://github.com/tragedy-labs/sprite
A TypeScript / JavaScript driver for ArcadeDB
https://github.com/tragedy-labs/sprite
arcadedb arcadedb-driver deno es6 graph-database graphdatabase graphdb javascript nodejs typescript
Last synced: about 2 months ago
JSON representation
A TypeScript / JavaScript driver for ArcadeDB
- Host: GitHub
- URL: https://github.com/tragedy-labs/sprite
- Owner: tragedy-labs
- License: mit
- Created: 2024-07-12T18:50:52.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-07T17:09:14.000Z (10 months ago)
- Last Synced: 2025-03-24T20:05:21.996Z (2 months ago)
- Topics: arcadedb, arcadedb-driver, deno, es6, graph-database, graphdatabase, graphdb, javascript, nodejs, typescript
- Language: TypeScript
- Homepage: https://sprite.tragedy.dev
- Size: 2.75 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Sprite
Sprite is a TypeScript driver for ArcadeDB.
[Read the documentation](https://sprite.tragedy.dev), or see the examples below.
## Installation
(Use whichever package manager you prefer)
` @tragedy-labs/sprite`
## Examples
### SpriteServer
```ts
@import { SpriteServer } from '@tragedy-labs/sprite';
const server = new SpriteServer({
username: 'aUser',
password: 'aPassword',
address: 'http://localhost:2480'
});
async function example() {
const ready = await server.serverReady();
console.log(ready);
// true;
try {
const db = await server.createDatabase('aDatabase');
console.log(db.name);
// 'aDatabase'
const result = await db.command(
'sql',
'CREATE document TYPE aType'
);
console.log(result);
// [
// {
// operation: 'create document type',
// typeName: 'aType'
// }
// ]
// CRUD must be transactional
// Parameterized commands are used to prevent
// SQL injection, parameters are passed in an
// object as the third argument
db.transaction(async (trx) => {
const doc = trx.crud(
'sql',
'INSERT INTO aType SET aProperty = :aValue',
{ aValue: 1 }
);
});
} catch (error) {
throw new Error('Could not create database', { cause: error });
}
}
example();
```
### SpriteDatabase
```ts
@import { SpriteDatabase } from '@tragedy-labs/sprite';
@import type {
CreateDocumentType,
InsertDocument,
SelectFrom
} from '@tragedy-labs/sprite';
const db = new SpriteDatabase({
username: 'aUser',
password: 'aPassword',
address: 'http://localhost:2480',
databaseName: 'aDatabase'
});
type ExampleDoc = {
aValue: string;
};
async function example() {
try {
const created = await db.command(
'sql',
'CREATE document TYPE aType'
);
console.log(created);
// [
// {
// operation: 'create document type',
// type: 'aType'
// }
// ]
const schema = await db.getSchema();
console.log(schema);
// [...]
// CRUD must be part of a transaction
// Parameterized commands are used to prevent
// SQL injection, parameters are passed in an
// object as the third argument.
db.transaction(async (trx) => {
await trx.crud(
'sql',
'INSERT INTO aType SET aProperty = :aValue',
{ aValue: 1 }
);
});
const docs = await db.query>(
'sql',
'SELECT * FROM aType'
);
console.log(docs);
// [
// {
// aProperty: 'aValue'
// }
// ]
} catch (error) {
throw new Error('An error occured...', { cause: error });
}
}
example();
```