Skip to content

typedb/typedb-tools

Repository files navigation

TypeDB

TypeDB Tools

Build & test GitHub release Discord

This repository contains the command-line tools that ship alongside TypeDB. Each tool is its own Rust binary in a Cargo workspace, sharing connection / TLS plumbing via a small common crate.

Tools

  • console/ — TypeDB Console: an interactive REPL for managing databases, running TypeQL queries, and executing scripts of console commands. See the console README for the full command reference and scripting model.
  • loader/ — TypeDB Loader: a bulk loader that drives a user-supplied TypeQL given-stage insert pipeline over a CSV file, with batching, parallel writes, reject capture, and resumable checkpoints. See the loader README for details.
  • typeql-check/ — TypeQL Check: a utility that verifies the syntactic validity of a given TypeQL query.

Repo layout

  • console/ — TypeDB Console sources, tests, and packaging.
  • loader/ — TypeDB Loader sources, tests, and packaging.
  • typeql-check/ — TypeQL Check sources.
  • common/ — Shared helpers (address parsing, TLS config) used by both tools.
  • binary/ — The typedb wrapper script that dispatches to either console or loader inside an assembled distribution (typedb console …, typedb loader …).
  • tool/ — Build / release tooling.

Updating release notes

We use the --tag-prefix, --include, and --exclude to generate release notes correctly

Console

NOTES_CREATE_TOKEN="..." bazel run @typedb_dependencies//tool/release/notes:create -- typedb typedb-tools <COMMIT_SHA> <RELEASE_VERSION> ./console/RELEASE_TEMPLATE.md ./console/RELEASE.md \
  --include console --exclude loader --exclude typeql-check --tag-prefix console-

Loader

NOTES_CREATE_TOKEN="..." bazel run @typedb_dependencies//tool/release/notes:create -- typedb typedb-tools <COMMIT_SHA> <RELEASE_VERSION> ./loader/RELEASE_TEMPLATE.md ./loader/RELEASE.md \
  --include loader --exclude console --exclude typeql-check --tag-prefix loader-

TypeQL Check

NOTES_CREATE_TOKEN="..." bazel run @typedb_dependencies//tool/release/notes:create -- typedb typedb-tools <COMMIT_SHA> <RELEASE_VERSION> ./typeql-check/RELEASE_TEMPLATE.md ./typeql-check/RELEASE.md \
  --include typeql-check --exclude console --exclude loader --tag-prefix typeql-check-

About

TypeDB Tools: tools and binaries for TypeDB and TypeDB Cluster

Topics

Resources

License

Contributing

Stars

10 stars

Watchers

7 watching

Forks

Packages

 
 
 

Contributors