Skip to content

The Concourse Guide#

Welcome to the Concourse Guide!

Concourse is an open source, distributed database warehouse for transactions, search, and analytics across time. This guide covers key concepts in Concourse, explains the API through examples, and provides advice for operations and administration.

For information about new features in the latest release, see the Concourse Release Notes.

Getting Started#

This quickstart walks you through installing Concourse, connecting to it, and performing basic operations.

1. Install Concourse#

The easiest way to install Concourse is with Conman, the Concourse Version Manager:

1
2
3
curl -o- https://packages.cinchapi.com/public/open-source/raw/names/conman/versions/1.0.0/install.sh | bash
conman install latest
conman start

Or use Docker:

1
docker run -p 1717:1717 --name concourse cinchapi/concourse

See Installation for all options.

2. Connect with CaSH#

Open the Concourse Shell:

1
concourse shell

3. Write Some Data#

1
2
3
4
5
[default/cash]$ insert({"name": "Jeff Nelson", "age": 30, "company": "Cinchapi"})
Returned '[1]' in 0.012 sec

[default/cash]$ add "role", "Founder", 1
Returned 'true' in 0.004 sec

4. Read Data Back#

1
2
3
4
5
[default/cash]$ get "name" from 1
Returned 'Jeff Nelson' in 0.003 sec

[default/cash]$ select 1
Returned '{age: [30], company: [Cinchapi], name: [Jeff Nelson], role: [Founder]}' in 0.005 sec

5. Query#

1
2
3
4
[default/cash]$ find "age > 25"
Returned '[1]' in 0.004 sec

[default/cash]$ select from where age > 25

6. Time Travel#

1
2
3
4
5
6
7
[default/cash]$ set "name", "Jeffrey Nelson", 1

[default/cash]$ get "name" from 1
Returned 'Jeffrey Nelson' in 0.003 sec

[default/cash]$ get "name" from 1 at "10 seconds ago"
Returned 'Jeff Nelson' in 0.004 sec

7. Connect from Java#

1
2
3
4
5
Concourse concourse = Concourse.connect();
long record = concourse.add("name", "Alice");
String name = concourse.get("name", record);
Set<Long> results = concourse.find("name = Alice");
concourse.close();

Next Steps#

  • Introduction — Learn about Concourse’s data model and key concepts
  • Data Types — Understand how Concourse handles different value types
  • Writing Data — Learn all the ways to write data
  • Reading Data — Learn about select, get, browse, and more
  • Queries — Master the Concourse Criteria Language
  • Configuration — Configure Concourse for your environment

Community#

  • GitHub — Source code, issue tracking, and releases
  • Release Notes — What’s new in each version

Getting Help#

Visit the Cinchapi Support Center at https://support.cinchapi.com to view knowledge base articles or file support requests.

Licensing#

Concourse is released under the Apache License, Version 2.0. For more information see the LICENSE and NOTICE files included in the Concourse repository.