cassandra-data-apis

Data APIs for Apache Cassandra

Easy to use APIs for accessing data stored in Apache Cassandra.

These APIs can be used as a standalone server using either Docker or manually running a server. They can also be embedded in existing applications using HTTP routes.

Currently, this project provides GraphQL APIs. Other API types are possible in the future.

Getting Started

Installation

docker pull datastaxlabs/cassandra-data-apis
docker run --rm -d -p 8080:8080 -e DATA_API_HOSTS=<cassandra_hosts_here> datastaxlabs/cassandra-data-apis

You can also manually build the docker image and/or the server using the instructions below.

Using GraphQL

By default, a GraphQL endpoint is started. Use the GraphQL documentation for getting started.

Configuration

Configuration for Docker can be done using either environment variables, a mounted configuration file, or both.

Add additional configuration using environment variables by adding them to the docker run command.

docker run -e DATA_API_HOSTS=127.0.0.1 -e DATA_API_KEYSPACE=example ...

Using a configuration file

To use a configuration file, create a file with the following contents:

hosts:
  # Change to your cluster's hosts
  - 127.0.0.1
# keyspace: example
# username: cassandra
# password: cassandra

# See the "Settings" section for additional configuration

Then start docker with:

docker run -p 8080:8080 -v "${PWD}/<your_config_file>.yaml:/root/config.yaml" datastaxlabs/cassandra-data-apis

Settings

Configuration Types

The strings type expects a comma-delimited list e.g. 127.0.0.1, 127.0.0.2, 127.0.0.3 when using environment variables or a command flag, and it expects an array type when using a configuration file.

YAML:

--- 
host: 
  - "127.0.0.1"
  - "127.0.0.2"
  - "127.0.0.3"

JSON:

{
	"hosts": ["127.0.0.1", "127.0.0.2", "127.0.0.3"]
}

Schema Management Operations

Building

This section is mostly for developers. Pre-built docker image recommended.

Building the Docker Image

cd <path_to_data-apis>/cassandra-data-apis
docker build -t cassandra-data-apis .

Run locally with single node, local Cassandra cluster

cd <path_to_data-apis>/cassandra-data-apis
docker build -t cassandra-data-apis .

# On Linux (with a cluster started on the docker bridge: 172.17.0.1)
docker run -p 8080:8080 -e "DATA_API_HOSTS=172.17.0.1" cassandra-data-apis

# With a cluster bound to 0.0.0.0
docker run --network host -e "DATA_API_HOSTS=127.0.0.1" cassandra-data-apis

# On macOS (with a cluster bound to 0.0.0.0)
docker run -p 8080:8080 -e "DATA_API_HOSTS=host.docker.internal" cassandra-data-apis

These host values can also be used in the configuration file approach used in the previous section.

Build and run as a standalone webserver

If you want to run this module as a standalone webserver, use:

# Define the keyspace you want to use
# Start the webserver
go build run.exe && ./run.exe --hosts 127.0.0.1 --keyspace store

Your settings can be persisted using a configuration file:

hosts:
  - 127.0.0.1
keyspace: store
operations:
  - TableCreate
  - KeyspaceCreate
port: 8080
schema-update-interval: 30s

To start the server using a configuration file, use:

./run.exe --config <your_config_file>.yaml

Settings can also be overridden using environment variables prefixed with DATA_API_:

DATA_API_HOSTS=127.0.0.1 DATA_API_KEYSPACE=store ./run.exe --config <your_config_file>.yaml

Plugin the routes within your HTTP request router

Installation

go get github.com/datastax/cassandra-data-apis

Using the API

To add the routes to your existing HTTP request router, use:

cfg := endpoint.NewEndpointConfig("your.first.contact.point", "your.second.contact.point")
// Setup config here using your env variables
endpoint, err := cfg.NewEndpoint()
if err != nil {
	log.Fatalf("unable create new endpoint: %s", err)
}
keyspace := "store"
routes, err = endpoint.RoutesKeyspaceGraphQL("/graphql", keyspace)
// Setup routes on your http router

License

© DataStax, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.