Datacoral Documentation

Datacoral Documentation

  • Release Notes
  • Back to datacoral.com

›CLI Reference

Getting Started

  • Home
  • Install CLI
  • Install Datacoral

CLI Reference

  • Collect Commands
  • Organize Commands
  • CLI Cheatsheet
  • Redshift Materialized Views Cheatsheet
  • Athena Materialized Views Cheatsheet
  • Troubleshooting Documentation

Collect Slices

  • Collect Overview
  • API Slices

    • Asana
    • Asana Premium
    • CloudWatch
    • Datadog
    • Delighted
    • Facebook
    • Fountain
    • FullStory
    • GitHub
    • Google Analytics
    • Google Adwords
    • Greenhouse
    • HubSpot
    • Intercom
    • JIRA
    • Launch Darkly
    • NetSuite
    • Non-Datacoral
    • Outreach
    • Phabricator
    • Pingdom
    • S3
    • Salesforce
    • Stripe
    • Zendesk
    • Zuora

    Database Slices

    • Database Collect Slices
    • Firebase
    • MongoDB
    • MySQL
    • MySQL CDC
    • PostgreSQL

    Events Slices

    • Events Overview
    • Android
    • Browser
    • Objective-C (iOS)
    • Pixel Tracking
    • nodeJS
    • Python
    • .Net
    • Ruby
    • Snowplow Events

Organize Slices

  • Data Organization
  • Managed Redshift
  • Managed Glue

Harness Slices

  • Harness Overview

Technical Documents

  • Timelabels
  • Definitions
  • Materialized Views
  • Security Architecture
  • Encrypt Password
  • Configuring Alerts
  • Existing Redshift

Command Line Interface Cheatsheet

This is a quick introductory section on the CLI. As you add more slices, you will use these primitives to manage your Datacoral deployment.

<slice-category> refers to one of collect, organize, and harness. However, in this version, we only support collect and organize.

  • <slice-type> refers to the type of slice, for example Google Analytics or MySQL.
  • <slice-name> Is a user definable name of the instance of the slice you have deployed. For example if you have 3 MySQL slices for the 3 databases you want to connect, you would name the slices accordingly.

List all the available slices

datacoral <slice-category> list-slice-types

Describe slice types

Describe the input and output parameters needed for a given slice-type

datacoral <slice-category> describe --slice-type <slice-type>

There are several arguments relating to the describe command including to see those arguments and their definition type. The other arguments are:

--input-parameters   list input parameters
--output-parameters  list output parameters
--docs               print slice documentation
--help           output usage information

Add a slice

datacoral <slice-category> add --slice-type <slice-type> --slice-name <slice-name> [--parameters-file <params-file>]

Describe a deployed slice

List the input and output parameters for a deployed slice

datacoral describe --slice-name <slice-name>

List installed slices

datacoral <slice-category> list

Update a slice

A. Update only the slice software

datacoral <slice-category> update --slice-name <slice-name>

B. Update only the configuration

datacoral <slice-category> update --slice-name <slice-name> --configuration-only [--parameters-file <params-file>]

C. Update slice software and the configuration

datacoral <slice-category> update --slice-name <slice-name> --parameters-file <params-file>

Remove a slice

datacoral remove --slice-name <slice-name>
← Organize CommandsRedshift Materialized Views Cheatsheet →
datacoral

Product

OverviewWhy Datacoral ?Slice Catalog

Customers

CustomersGreenhouse Case StudyFront Case Study

Company

AboutTeamCareersBlog

Legal

Privacy Policy
Copyright © 2019 Datacoral