Skip to main content

slack datastore

Interact with an app's datastore

Description​

Interact with the items stored in an app's datastore.

This command is supported for apps deployed to Slack managed infrastructure but other apps can attempt to run the command with the --force flag.

Discover the datastores: https://docs.slack.dev/tools/deno-slack-sdk/guides/using-datastores

slack datastore <subcommand> <expression> [flags]

Flags​

  -h, --help   help for datastore

Global flags​

  -a, --app string           use a specific app ID or environment
      --config-dir string    use a custom path for system config directory
  -e, --experiment strings   use the experiment(s) in the command
  -f, --force                ignore warnings and continue executing command
      --no-color             remove styles and formatting from outputs
  -s, --skip-update          skip checking for latest version of CLI
  -w, --team string          select workspace or organization by team name or ID
      --token string         set the access token associated with a team
  -v, --verbose              print debug logging and additional info

Examples​

# Add a new entry to the datastore
$ slack datastore put --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}'

# Add two new entries to the datastore
$ slack datastore bulk-put --datastore tasks '{"items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}'

# Update the entry in the datastore
$ slack datastore update --datastore tasks '{"item": {"id": "42", "description": "Create a PR", "status": "Done"}}'

# Get an item from the datastore
$ slack datastore get --datastore tasks '{"id": "42"}'

# Get two items from datastore
$ slack datastore bulk-get --datastore tasks '{"ids": ["12", "42"]}'

# Remove an item from the datastore
$ slack datastore delete --datastore tasks '{"id": "42"}'

# Remove two items from the datastore
$ slack datastore bulk-delete --datastore tasks '{"ids": ["12", "42"]}'

# Query the datastore for specific items
$ slack datastore query --datastore tasks '{"expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}'

# Count number of items in datastore
$ slack datastore count --datastore tasks

See also​