Configuration
  • Overview
  • Application Configuration
  • Documentation Configuration
  • Spec Configuration
    • Features
  • Asynchronous Processing
  • Cassandra Time-Series Engine
  • Cassandra Integration
  • Default Controller Customisation
  • Documentation
  • Documentation
  • Request Parameters
    • Tutorials
  • Step-by-Step Guide
  • Archetype Setup
  • Prometheus
  • Sentry Logging
    • UI Customisation
  • UI Customisation
  • SASS Build Chain
  • Shared Layout
  • API Documentation
  • Model Documentation
  • Results
  • sapi-nt v 1.2.2

    Cassandra Integration

    This document contains some information about integrating sapi-nt with a Cassandra database. See here for more notes on time series.

    Data Source

    You can configure a data source which accepts CQL queries and sends them to a Cassandra data store.

    Cassandra data source specs have a type value of cassandraDataSource and can have the following properties:

    Property Meaning  Default
    contactPoints A list of address of the nodes to be contacted initially before node discovery  
    keyspace A keyspace in Cassandra is a namespace that defines data replication on nodes. A cluster contains one keyspace per node dev
    port A port on which to connect 9042
    authenticationMode Set the authentication mode. none
    connectTimeout Timeout for establishing connection to cassandra, in milliseconds 5000
    readTimeout Timeout for completing a read query, in milliseconds 5000

    Example

    name     : defaultDataSource
    type     : cassandraDataSource
    contactPoints:
      - localhost
    port     : 9142
    keyspace : dev
    

    Endpoint

    You can configure an endpoint which emits time series data from a Cassandra data source.

    Time series endpoint specs have a type value of timeseries and can have the following properties, in addition to the properties usually allowed on list endpoint specs:

    Property Meaning
    byDateTable The name of the cassandra table to use for measurements indexed by date.
    byMeasureTable The name of the cassandra table to use for measurements indexed by measurereference.
    measureURI The base URI for measurementreferences.
    observationURI An optional base URI for individual observations.
    measureParam The property name used to filter on/report the measurement reference.
    timestampParam The property name used to filter on/report the timestamp parameter.