Doculite

https://github.com/stefanbielmeier/doculite
Admin
Doculite allows you to use SQLite like Firebase Firestore, supporting document listeners,...
Tokens:1,665
Snippets:7
Trust Score:7.6
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get a Document from Doculite (JavaScript)

Source: https://github.com/stefanbielmeier/doculite/blob/main/readme.md

Illustrates how to retrieve a specific document from a collection using its reference. If the document does not exist, the get operation will return null.

```javascript
// define ref
const usersRef = db.collection("users").doc("123");
// get
const user = await usersRef.get();
// print
console.log(user); // prints { username: "John Doe" };
```

--------------------------------

### Query Documents by Equality in Doculite (JavaScript)

Source: https://github.com/stefanbielmeier/doculite/blob/main/readme.md

Explains how to query documents within a collection based on an equality condition. The `where` method filters documents, and `get` retrieves the matching results.

```javascript
const usersRef = db.collection("users");

await usersRef.doc().set({ username: "Doculite", updatedAt: 234 });

const query = usersRef.where("username", "Doculite");

const docs = await query.get();

const user = docs[0];

console.log(user.username); // prints `Doculite`
```

--------------------------------

### Initialize Doculite Database (JavaScript)

Source: https://github.com/stefanbielmeier/doculite/blob/main/readme.md

Demonstrates how to initialize a new Doculite database instance. This action creates an SQLite database file (e.g., 'sqlite.db') in the current working directory.

```javascript
import { Database } from "doculite";

// Creates sqlite.db file in the cwd
const db = new Database();
```

--------------------------------

### Create and Set Documents in Doculite (JavaScript)

Source: https://github.com/stefanbielmeier/doculite/blob/main/readme.md

Shows how to create references to documents within collections and set their data. Collections are automatically created upon the first document insertion. Any valid JSON-serializable JavaScript object can be stored as a document.

```javascript
// create ref to the doc. Doc ID optional.
const usersRef = db.collection("users").doc("123");
const refWithoutId = db.collection("users").doc();

// Any valid Javascript object that can be parsed to valid JSON can be inserted as a document.

await usersRef.set({
  username: "John Doe",
  createdAt: "123",
  updatedAt: "123",
});
await refWithoutId.set({ username: "Jane Doe" });
```

--------------------------------

### Listen to Document Updates in Doculite (JavaScript)

Source: https://github.com/stefanbielmeier/doculite/blob/main/readme.md

Shows how to subscribe to real-time updates for a specific document. The `onSnapshot` method returns an unsubscribe function to stop listening.

```javascript
// ref to doc
const ref = db.collection("users").doc("123");

// snapshot listener returns unsubscribe function
const unsub = ref.onSnapshot((doc) => {
  console.log("Omg the user doc is updating!", doc?.username);
});

await ref.set({ username: "SHEESH Doe", updatedAt: 2 });
// prints: `Omg the user doc is updating! SHEESH Doe`

// unsub
unsub();
```

--------------------------------

### Update Documents in Doculite (JavaScript)

Source: https://github.com/stefanbielmeier/doculite/blob/main/readme.md

Explains how to update existing documents. The `set` method can merge new data with existing document fields or overwrite the entire document based on the `merge` option. Merge is true by default.

```javascript
// ref
const usersRef = db.collection("users").doc("123");

// Properties existing on both old and new object will be updated.
// Properties only existing on the new object will be added.

// If merge is false, properties only present on the old object will be deleted.
// Merge is true by default

await usersRef.set({ username: "DERP Doe", updatedAt: "345" }, { merge: true });
// document in DB is now { username: "DERP Doe", updatedAt: "345", createdAt: "123" }

await usersRef.set({ username: "DERP Doe", updatedAt: "345" }, { merge: false });
// document in DB is now { username: "DERP Doe", updatedAt: "345" }
```

--------------------------------

### Delete Documents in Doculite (JavaScript)

Source: https://github.com/stefanbielmeier/doculite/blob/main/readme.md

Demonstrates the process of deleting a document from a collection. After deletion, attempting to retrieve the document will return null.

```javascript
const db = new Database();

const ref = db.collection("users").doc("deletable");

await ref.set({ username: "deletableUsername", updatedAt: 123123 });

await ref.delete();

const doc = await ref.get();

console.log(doc); // prints null
```
Tokens:
Raw