kasandra.schema — org.clojars.rosado/kasandra 0.2.0

Utilities for creating/navigating an in-memory represenatation of a Cassandra keyspace.

Notes: expect functions with match-X prefix to mostly do matching (via core.match). Functions without the match-X prefix should return objects ready for use.

The CQL parser uses a slightly modified ANTLR grammar file available from

https://github.com/antlr/grammars-v4/tree/master/cql3

-column-names clj multimethod

Returns a vector of column names (strings)

add-index clj

(add-index schema-info)

Adds :index to schema-info

CljAntlrOutput clj

column-names clj

(column-names definition)

Returns a vector of column names (strings)

create-table clj

(create-table form)

Returns

create-view clj

(create-view form)

deep-vectorize clj

(deep-vectorize form)

clj-antlr uses cons list, we want to turn them into vectors because core.match's syntax for matching vectors is less verbose.

find-cql clj

(find-cql parsed kw)

Takes output of clj-antlr.core/parse and collects all CLQ forms starting with given keyword. Returns a seq.

• kw keyword, e.g. :createTable

FormFinder clj protocol

Finds occurences of tables or views in parser output.

-find-tables clj

(-find-tables _ opts)

Returns a collection of :kasandra.schema/table

-find-views clj

(-find-views _ opts)

Returns a collection of :kasandra.schema/materialized-view

lookup-by-name clj

(lookup-by-name schema-info name)

Given the schema info (which should include the index) get the table or view with that name or nil.

make-primary-key clj

(make-primary-key partition-key clustering-key)

match-column-definition clj

(match-column-definition form)

returns a tuple of [(:column | :pk | :pk-column) payload]

match-create-table clj

(match-create-table form)

Returns a map of shape: {::table ... ::keyspace ... ::columns []}

merged with keys returned by match-create-table-with

match-create-table-clustering-key clj

(match-create-table-clustering-key form)

Returns a vector of tuples like ["col-name" :asc]

match-create-table-clustering-key-column clj

(match-create-table-clustering-key-column form)

match-create-table-option-item clj

(match-create-table-option-item form)

match-create-table-options clj

(match-create-table-options form)

match-create-table-with clj

(match-create-table-with form)

Returns a map of shape: {::table-options ... ::clustering-key [[string kw]*]}

match-create-view clj

(match-create-view form)

match-option-hash-item clj

(match-option-hash-item form)

match-primary-key clj

(match-primary-key form)

match-view-clustering-order clj

(match-view-clustering-order form)

MatchBasedSchemaInfoProvider clj

materialized-views clj

(materialized-views provider parsed)

Returns a collection of materialized view defintions.

primary-key-column-names clj

(primary-key-column-names table-or-view)

Returns a vector of column names comprising the primary key.

schema-index clj

(schema-index schema-info)

Creates an index for easy look up of tables/views by name

schema-info clj

(schema-info provider cql)

(schema-info provider cql options)

Returns a map containing :tables and :views. Supported options:

• :index - set to :include and result map will contain :index entry with a map of name -> path that can be used to lookup the item in the schema info.

SchemaParser clj protocol

Parses DB schema and outputs something TableInfoProvider and ViewInfoProvider can use.

-parse clj

(-parse self input)

search-schema-info clj

(search-schema-info schema-info regex)

Returns a seq of tuples [name location] where location is a path to the item in passed schema-info.

syntax-comma? clj

(syntax-comma? form)

TableInfoProvider clj protocol

Extracts table definition from parser output.

-tables clj

(-tables this parsed)

Returns a collection of table definitions.

tables clj

(tables provider parsed)

Returns a collection of table definitions.

ViewInfoProvider clj protocol

Extracts materialized view definitions from parser output

-views clj

(-views this parsed)

Returns a collection of view definitions