tigris-cli

README

Tigris Command Line Interface

Create databases and collections, read and write data, perform transactions, stream events and setup Tigris locally, all from the command line.

Documentation

• Quickstart
• Working Locally
• Command Reference

Installation

The tigris CLI tool can be installed as follows:

macOS

curl -sSL https://tigris.dev/cli-macos | sudo tar -xz -C /usr/local/bin

Linux

curl -sSL https://tigris.dev/cli-linux | sudo tar -xz -C /usr/local/bin

Usage

$ tigris
tigris is the command line interface of Tigris data platform

Usage:
  tigris [command]

Available Commands:
  alter       alter collection
  completion  Generate completion script
  create      creates database or collection
  delete      delete documents
  describe    describe database or collection
  docs        Generates CLI documentation in Markdown format
  drop        drop database or collection
  events      Streams and outputs events
  generate    Generating helper assets such as sample schema
  help        Help about any command
  insert      insert document
  list        list databases of the project or list database collections
  local       Starting and stopping local Tigris server
  ping        Check connection to Tigris
  read        read documents
  replace     replace document
  scaffold    Scaffold a project for specified language
  search      Searches a collection for documents matching the query
  server      Tigris server related commands
  transact    run a set of operations in a transaction
  update      update documents
  version     show tigris cli version

Flags:
  -h, --help   help for tigris

Use "tigris [command] --help" for more information about a command.

Examples

# Start up Tigris locally on port 8081
tigris local up

# Create sample schema
tigris generate sample-schema --create

# Create database and collection
tigris create database testdb
tigris create collection testdb \
'{
    "title": "users",
    "description": "Collection of documents with details of users",
    "properties": {
      "id": {
        "description": "A unique identifier for the user",
        "type": "integer"
      },
      "name": {
        "description": "Name of the user",
        "type": "string",
        "maxLength": 100
      }
    },
    "primary_key": [
      "id"
    ]
}'

# Insert some data
tigris insert_or_replace sampledb users \
'[
    {"id": 1, "name": "Jania McGrory", "balance": 6045.7},
    {"id": 2, "name": "Bunny Instone", "balance": 2948.87}
]'

# Read data
tigris read sampledb users '{"id": 1}'

# Perform a transaction
tigris transact sampledb \
'[
  {
    "insert": {
      "collection": "orders",
      "documents": [{
          "id": 1, "user_id": 1, "order_total": 53.89, "products": [{"id": 1, "quantity": 1}]
        }]
    }
  },
  {
    "update": {
      "collection": "users", "fields": {"$set": {"balance": 5991.81}}, "filter": {"id": 1}
    }
  },
  {
    "update": {
      "collection": "products", "fields": {"$set": {"quantity": 6357}}, "filter": {"id": 1}
    }
  }
]'

# Shutdown the local Tigris
tigris local down

License

This software is licensed under the Apache 2.0.