Commands

The bulk-delete operation takes an array of ids and deletes those items as in the following example.

On MacOS & Linux:

slack datastore bulk-delete '{ "datastore": "running_datastore", "ids": ["41","36"]}'

On Windows:

slack datastore bulk-delete ('{"datastore":"running_datastore", "ids":["41","36"]}' | ConvertTo-JSON)

The bulk-get operation takes an array of ids and retrieves those items as in the following example.

On MacOS & Linux:

slack datastore bulk-get '{ "datastore": "running_datastore", "ids": ["41","36"]}'

On Windows:

slack datastore bulk-get ('{"datastore":"running_datastore", "ids":["41","36"]}' | ConvertTo-JSON)

Let's use the datastore we defined in the Virtual Running Buddies sample app to add an item to the datastore. Given our datastore definition:

// datastores/run_data.ts
import { DefineDatastore, Schema } from "deno-slack-sdk/mod.ts";

export const RUN_DATASTORE = "running_datastore";

const RunningDatastore = DefineDatastore({
  name: RUN_DATASTORE,
  primary_key: "id",
  attributes: {
    id: {
      type: Schema.types.string,
    },
    runner: {
      type: Schema.slack.types.user_id,
    },
    distance: {
      type: Schema.types.number,
    },
    rundate: {
      type: Schema.slack.types.date,
    },
  },
});

export default RunningDatastore;

The bulk-put request can look like:

On MacOS & Linux:

slack datastore bulk-put '{ "datastore": "running_datastore", "items": [{ "id": "50", "runner": "ABCD1234EFG", "distance": "26.2", "rundate": "2023-03-19"}] }'

On Windows:

slack datastore bulk-put ('{"datastore": "running_datastore", "items": [{ "id": "50", "runner": "ABCD1234EFG", "distance": "26.2", "rundate": "2023-03-19"}] }' | ConvertTo-JSON)

Be sure to double-check that the item's property names are correct when executing the bulk-put command; if they are not, they will be ignored. If the API call is otherwise successful, no error code will be returned, and you'll have some garbage data on your hands.

Replacing data is done in the same way as creating data: provide the primary key of the item you'd like to replace.

You can import data from a JSON Lines file to a datastore like so:

slack datastore bulk-put '{"datastore": "running_datastore"}' —-from-file /path/to/file.jsonl

The delete operation takes a primary key and deletes an item as in the following example.

On MacOS & Linux:

slack datastore delete '{ "datastore": "running_datastore", "id": "50" }'

On Windows:

slack datastore delete ('{"datastore":"running_datastore", "id":"50"}' | ConvertTo-JSON)

You'll see the following in your terminal:

🎉  Deleted from datastore: running_datastore

primary_key: 50
To inspect the datastore after updates, run slack datastore query [expression]

The get command is used to retrieve a single item by its primary key. Below is an example.

On MacOS & Linux:

slack datastore get '{ "datastore": "running_datastore", "id": "50" }'

On Windows:

slack datastore get ('{"datastore":"running_datastore", "id":"50"}' | ConvertTo-JSON)

You'll see the following in your terminal:

🎉  Get from Datastore: running_datastore

{
  "distance": 26.2,
  "id": "50",
  "rundate": "2023-03-19",
  "runner": "ABCD1234EFG"
}
To inspect the datastore after updates, run slack datastore get [expression]

Let's use the datastore we defined in the Virtual Running Buddies sample app to add an item to the datastore. Given our datastore definition:

// datastores/run_data.ts
import { DefineDatastore, Schema } from "deno-slack-sdk/mod.ts";

export const RUN_DATASTORE = "running_datastore";

const RunningDatastore = DefineDatastore({
  name: RUN_DATASTORE,
  primary_key: "id",
  attributes: {
    id: {
      type: Schema.types.string,
    },
    runner: {
      type: Schema.slack.types.user_id,
    },
    distance: {
      type: Schema.types.number,
    },
    rundate: {
      type: Schema.slack.types.date,
    },
  },
});

export default RunningDatastore;

The put request can look like:

On MacOS & Linux:

slack datastore put '{ "datastore": "running_datastore", "item": { "id": "50", "runner": "ABCD1234EFG", "distance": "26.2", "rundate": "2023-03-19"} }'

On Windows:

slack datastore put ('{"datastore": "running_datastore", "item": { "id": "50", "runner": "ABCD1234EFG", "distance": "26.2", "rundate": "2023-03-19"} }' | ConvertTo-JSON)

You'll see the following in your terminal:

🎉  Stored below record in the datastore: running_datastore

{
  "distance": 26.2,
  "id": "50",
  "rundate": "2023-03-19",
  "runner": "ABCD1234EFG"
}
To inspect the datastore after updates, run slack datastore query [expression]

Be sure to double-check that the item's property names are correct when executing the put command; if they are not, they will be ignored. If the API call is otherwise successful, no error code will be returned, and you'll have some garbage data on your hands.

Replacing data is done in the same way as creating data: provide the primary key of the item you'd like to replace.

Use the query command when you're looking for a number of items, or when you don't know the ID of a particular item.

✨ To learn more about the language used for making queries, check out querying the datastore.

Let's check out what a query for runs logged on a certain date (March 19th, 2023) looks like:

On MacOS & Linux:

slack datastore query '{ "datastore": "running_datastore", "expression": "rundate = :rundate", "expression_values": {":rundate": "2023-03-19"} }'

On Windows:

slack datastore query ('{"datastore":"running_datastore", "expression":"rundate = :rundate", "expression_values":{":rundate":"2023-03-19"} }' | ConvertTo-JSON)

You'll see the following in your terminal:

🎉  Retrieved 1 items from datastore: running_datastore

{
  "distance": 26.3,
  "id": "50",
  "rundate": "2023-03-19",
  "runner": "ABCD1234EFG"
}
To create or update existing items run slack datastore put [item]

If you were to run this command without any expression, as in the following example:

On MacOS & Linux:

slack datastore query '{"datastore": "running_datastore"}'

On Windows:

slack datastore query ('{"datastore": "running_datastore"}' | ConvertTo-JSON)

It would return all of the items in the datastore. Be careful though, as you could end up thinking you've lost data, when it could actually just be on another page.

You can export data from a datastore to a JSON Lines file like so:

slack datastore query '{"datastore": "running_datastore"}' —-to-file /path/to/file.jsonl

The Time To Live feature allows you to make datastore items automatically expire, and then be automatically deleted. The process is not instant, so there may be some expired items that have not been deleted from the datastore yet.

Here is an example of a query command that filters out any expired items that have not been automatically deleted yet:

slack datastore query 
'{
    "datastore": "DraftDatastore", 
    "expression": "attribute_not_exists(#expire_ts) OR #expire_ts > :timestamp", 
    "expression_attributes": {"#expire_ts": "expire_ts"}, 
    "expression_values": {":timestamp":1708448410}
}'

The timestamp should be set to the current time.

Unlike the put command, which will overwrite an entire datastore item, the update command will only overwrite the individual fields included in the command. Below is an example.

On MacOS & Linux:

slack datastore update '{ "app_id": "UVW987XYZ65", "datastore": "running_datastore", "item": { "id": "50", "runner": "ABCD1234EFG", "distance": "26.3", "rundate": "2023-03-19"} }'

On Windows:

slack datastore update ('{ "app_id":"UVW987XYZ65", "datastore":"running_datastore", "item": {"id":"50", "runner":"ABCD1234EFG", "distance":"26.3", "rundate":"2023-03-19"} }' | ConvertTo-JSON)

You'll see the following in your terminal:

🎉  Stored below record in the datastore: running_datastore

{
  "distance": 26.3,
  "id": "50",
  "rundate": "2023-03-19",
  "runner": "ABCD1234EFG"
}
To inspect the datastore after updates, run slack datastore query [expression]