Database Functions on Server

No Code Example

Use these snippets anywhere you want to in any script.

Full Docs

Methods

1. getSimpleData(collectionName, documentName)

Retrieves data from a specified collection and document.

• Arguments

  • collectionName - The name of the collection.

  • documentName - The name of the document.

• Returns

  • The requested data.

• Usage

  game.getSimpleData('yourCollectionName', 'yourDocumentName').then(data => {
    console.log(data);
  });

2. patchSimpleData(collectionName, documentName, fieldMap)

Updates specific fields in a document.

• Arguments

  • collectionName - The name of the collection.

  • documentName - The name of the document.

  • fieldMap - An object containing the fields to be updated.

• Returns

  • Confirmation of the update.

• Usage

  const updates = { fieldName: 'newValue' };
  game.patchSimpleData('yourCollectionName', 'yourDocumentName', updates).then(response => {
    console.log(response);
  });

3. setSimpleData(collectionName, documentName, fieldMap)

Sets data for a specific document, overwriting any existing data.

• Arguments

  • collectionName - The name of the collection.

  • documentName - The name of the document.

  • fieldMap - An object with the data to be set.

• Returns

  • Confirmation of the operation.

• Usage

  const data = { key: 'value' };
  game.setSimpleData('yourCollectionName', 'yourDocumentName', data).then(response => {
    console.log(response);
  });

4. deleteSimpleData(collectionName, documentName)

Deletes a document from a collection.

• Arguments

  • collectionName - The name of the collection.

  • documentName - The name of the document to be deleted.

• Returns

  • Confirmation of the deletion.

• Usage

  game.deleteSimpleData('yourCollectionName', 'yourDocumentName').then(response => {
    console.log(response);
  });

Additional Information

• All methods are asynchronous and return a promise.

• Ensure proper error handling in your implementation to manage potential exceptions.