From 3718c45e37b8b778280b8f11420d6bd22e75bad5 Mon Sep 17 00:00:00 2001 From: Adam Dougal Date: Fri, 22 Sep 2017 15:51:35 +0100 Subject: [PATCH] Adds Cql file comments information to README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 5c5390e..611d47c 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,23 @@ as a traditional relational database. inconsistent schema across nodes in case of split brain or other situation. `cqlmigrate` tries to alleviate this with appropriate consistency levels. +## Cql File Comments + +There are a number of ways to add comments to your `cql` files. + +For inline comments prepend `--` to your comment, e.g: + + -- Select Queries + SELECT * FROM schema_updates; + +For multiline comments wrap them with `/*` and `*/`, e.g: + + /* + Added by John Smith + 19th September 2017 + */ + SELECT * FROM schema_updates; + # Contributors Originally developed by the Cirrus team at Sky.