From f49cbf78ae9c2a714d38e29e6e575a397caa51bb Mon Sep 17 00:00:00 2001 From: WSO2 Builder Date: Mon, 18 Feb 2019 11:42:02 +0000 Subject: [PATCH] [WSO2-Release] [Release 4.1.0] update documentation for release 4.1.0 --- README.md | 4 +-- docs/api/4.1.0.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++ docs/api/latest.md | 2 +- docs/index.md | 4 +-- mkdocs.yml | 1 + 5 files changed, 67 insertions(+), 5 deletions(-) create mode 100644 docs/api/4.1.0.md diff --git a/README.md b/README.md index 56d21ba..817e161 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Find some useful links below: ## Latest API Docs -Latest API Docs is 4.0.14. +Latest API Docs is 4.1.0. ## Prerequisites @@ -48,7 +48,7 @@ Latest API Docs is hbase *(Store)*

This extension assigns data sources and connection instructions to event tables. It also implements read-write operations on connected datasources. Including one or more primary keys in the event table configuration allows any record to by identified by a unique combination of primary key values. Read-write operations can be performed for the records once they are thus identified.

+* hbase *(Store)*

This extension assigns data sources and connection instructions to event tables. It also implements read-write operations on connected datasources. Including one or more primary keys in the event table configuration allows any record to by identified by a unique combination of primary key values. Read-write operations can be performed for the records once they are thus identified.

## How to Contribute diff --git a/docs/api/4.1.0.md b/docs/api/4.1.0.md new file mode 100644 index 0000000..8445701 --- /dev/null +++ b/docs/api/4.1.0.md @@ -0,0 +1,61 @@ +# API Docs - v4.1.0 + +## Store + +### hbase *(Store)* + +

This extension assigns data sources and connection instructions to event tables. It also implements read-write operations on connected datasources. Including one or more primary keys in the event table configuration allows any record to by identified by a unique combination of primary key values. Read-write operations can be performed for the records once they are thus identified.

+ +Syntax +``` +@Store(type="hbase", any.hbase.property="", table.name="", column.family="") +@PrimaryKey("PRIMARY_KEY") +@Index("INDEX") +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
any.hbase.propertyAny property that can be specified for HBase connectivity in hbase-site.xml is also accepted by the HBase Store implementation.STRINGNoNo
table.nameThe name with which the event table should be persisted in the store. If no name is specified via this parameter, the event table is persisted with the same name as the Siddhi table.The table name defined in the Siddhi Application query.STRINGYesNo
column.familyThe number of characters that the values for fields of the STRING type in the table definition must contain. If this is not specified, the default number of characters specific to the database type is considered.'wso2.sp'STRINGYesNo
+ +Examples +EXAMPLE 1 +``` +define stream StockStream (symbol string, price float, volume long); +@Store(type="hbase", table.name="StockTable", column.family="StockCF", hbase.zookeeper.quorum="localhost", hbase.zookeeper.property.clientPort="2181") +@PrimaryKey(symbol) +define table StockTable (symbol string, price float, volume long); +``` +

This definition creates an event table named StockTable with a column family StockCF on the HBase instance if it does not already exist (with 3 attributes named symbol, price, and volume of the string, float and long types respectively). The connection is made as specified by the parameters configured for the '@Store' annotation. The symbol attribute is considered a unique field, and the values for this attribute are the HBase row IDs.

+ diff --git a/docs/api/latest.md b/docs/api/latest.md index e231c3a..8445701 100644 --- a/docs/api/latest.md +++ b/docs/api/latest.md @@ -1,4 +1,4 @@ -# API Docs - v4.1.0-SNAPSHOT +# API Docs - v4.1.0 ## Store diff --git a/docs/index.md b/docs/index.md index 56d21ba..817e161 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,7 +10,7 @@ Find some useful links below: ## Latest API Docs -Latest API Docs is 4.0.14. +Latest API Docs is 4.1.0. ## Prerequisites @@ -48,7 +48,7 @@ Latest API Docs is hbase *(Store)*

This extension assigns data sources and connection instructions to event tables. It also implements read-write operations on connected datasources. Including one or more primary keys in the event table configuration allows any record to by identified by a unique combination of primary key values. Read-write operations can be performed for the records once they are thus identified.

+* hbase *(Store)*

This extension assigns data sources and connection instructions to event tables. It also implements read-write operations on connected datasources. Including one or more primary keys in the event table configuration allows any record to by identified by a unique combination of primary key values. Read-write operations can be performed for the records once they are thus identified.

## How to Contribute diff --git a/mkdocs.yml b/mkdocs.yml index 9bce849..db1d8ef 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,6 +32,7 @@ markdown_extensions: pages: - Welcome: index.md - API Docs: + - 4.1.0: api/4.1.0.md - 4.0.14: api/4.0.14.md - 4.0.13: api/4.0.13.md - 4.0.12: api/4.0.12.md