Skip to content

Supported Platforms

Use es init --platform <value> with one of these values:

  • snowflake
  • postgres
  • databricks
  • sqlite
  • tutorial

tutorial is a SQLite-based starter mode for local learning.

Snowflake

Required environment fields:

  • platform = snowflake
  • user
  • password
  • account
  • warehouse
  • database
  • schema

Optional field:

  • role

Postgres

Required environment fields:

  • platform = postgres
  • host
  • database
  • schema
  • user
  • password

Optional fields:

  • port
  • sslmode

Databricks

Required environment fields:

  • platform = databricks
  • server_hostname
  • http_path
  • access_token

Optional fields:

  • catalog
  • schema

SQLite

Required environment fields:

  • platform = sqlite
  • database (path to local .db file)

Example generated by es init --platform sqlite:

[default]
env = env.sqlite.dev

[env.sqlite.dev]
platform = sqlite
database = ...

Tutorial

tutorial uses SQLite and is designed for quick local onboarding.

What es init --platform tutorial does:

  • creates es.ini with env.sqlite.dev pointing to ./.echosphere/tutorial.db
  • creates es_suite/ with runnable example tests
  • creates/seeds the SQLite database with example customers and orders tables

Generated config snippet:

[default]
env = env.sqlite.dev

[env.sqlite.dev]
platform = sqlite
database = ./.echosphere/tutorial.db

Planned (Not Yet Supported)

  • Firebolt
  • Amazon Redshift
  • Azure Synapse
  • Google BigQuery
  • Microsoft SQL Server