camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject [4/4] camel git commit: Added camel-gora docs to gitbook
Date Sat, 02 Apr 2016 12:02:49 GMT
Added camel-gora docs to gitbook


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/34eb77f2
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/34eb77f2
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/34eb77f2

Branch: refs/heads/master
Commit: 34eb77f2cc29305b56a559589102dc258b154c91
Parents: 9a0e6d4
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Sat Apr 2 14:02:04 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Sat Apr 2 14:02:04 2016 +0200

----------------------------------------------------------------------
 .../src/main/docs/google-calendar.adoc          |   2 -
 components/camel-gora/src/main/docs/gora.adoc   | 259 +++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                  |   1 +
 3 files changed, 260 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/34eb77f2/components/camel-google-calendar/src/main/docs/google-calendar.adoc
----------------------------------------------------------------------
diff --git a/components/camel-google-calendar/src/main/docs/google-calendar.adoc b/components/camel-google-calendar/src/main/docs/google-calendar.adoc
index ba369a4..24b5abc 100644
--- a/components/camel-google-calendar/src/main/docs/google-calendar.adoc
+++ b/components/camel-google-calendar/src/main/docs/google-calendar.adoc
@@ -2,8 +2,6 @@
 GoogleCalendar Component
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-'''''
-
 *Available as of Camel 2.15*
 
 [[GoogleCalendar-ComponentDescription]]

http://git-wip-us.apache.org/repos/asf/camel/blob/34eb77f2/components/camel-gora/src/main/docs/gora.adoc
----------------------------------------------------------------------
diff --git a/components/camel-gora/src/main/docs/gora.adoc b/components/camel-gora/src/main/docs/gora.adoc
new file mode 100644
index 0000000..3664058
--- /dev/null
+++ b/components/camel-gora/src/main/docs/gora.adoc
@@ -0,0 +1,259 @@
+[[Gora-GoraComponent]]
+Gora Component
+~~~~~~~~~~~~~~
+
+*Camel-Gora* is an http://camel.apache.org/[Apache Camel] component that
+allows you to work with NoSQL databases using the
+http://gora.apache.org/[Apache Gora] framework.
+
+*Available as of Camel 2.14*
+
+Maven users will need to add the following dependency to their pom.xml
+for this component:
+
+[source,xml]
+---------------------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-gora</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+---------------------------------------------------------
+
+[[Gora-ApacheGoraOverview]]
+Apache Gora Overview
+~~~~~~~~~~~~~~~~~~~~
+
+The http://gora.apache.org/[Apache Gora] open source framework provides
+an in-memory data model and persistence for big data. Gora supports
+persisting to column stores, key value stores, document stores and
+RDBMSs, and analyzing the data with extensive
+http://hadoop.apache.org/[Apache Hadoop™ MapReduce] support. Gora uses
+the http://www.apache.org/licenses/LICENSE-2.0.html[Apache Software
+License v2.0] and graduated from the Apache Incubator in Janauary 2012
+to become a top-level Apache project.
+
+Apache Gora currently supports the following datastores:
+http://hbase.apache.org/[Apache HBase],
+http://cassandra.apache.org/[Apache Cassandra],
+http://accumulo.apache.org/[Apache Accumulo],
+http://aws.amazon.com/dynamodb/[Amazon DynamoDB] and SQL databases such
+as http://hsqldb.org/[hsqldb], http://www.mysql.com/[MySQL] and more.
+
+[[Gora-URIformat]]
+URI format
+~~~~~~~~~~
+
+[source,text]
+---------------------------
+gora:instanceName[?options]
+---------------------------
+
+Hbase examples with mandatory options :
+
+_XML_
+
+[source,xml]
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+<to uri="gora:foobar?keyClass=java.lang.Long&amp;valueClass=org.apache.camel.component.gora.generated.Pageview&amp;dataStoreClass=org.apache.gora.hbase.store.HBaseStore"/>
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+_Java DSL_
+
+[source,java]
+-------------------------------------------------------------------------------------------------------------------------------------------------------------
+to("gora:foobar?keyClass=java.lang.Long&valueClass=org.apache.camel.component.gora.generated.Pageview&dataStoreClass=org.apache.gora.hbase.store.HBaseStore")
+-------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+[[Gora-Configuratiion]]
+Configuratiion
+~~~~~~~~~~~~~~
+
+Using camel-gora needs some configuration. This mainly involve to
+configure the _AvroStore_ through the _gora.properties_ file and to
+define the relevant mappings as part of the
+_http://gora.apache.org/current/gora-core.html[gora-core]_ module.
+
+Extensive information for this configuration can be found in the apache
+http://gora.apache.org/current/index.html[gora documentation] and the
+http://gora.apache.org/current/gora-conf.html[gora-conf] page.
+
+[[Gora-Options]]
+Options
+~~~~~~~
+
+
+// component options: START
+The Gora component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The Gora component supports 22 endpoint options which are listed below:
+
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| name | common |  | String | *Required* Instance name
+| concurrentConsumers | common | 1 | int | Concurrent Consumers NOTE: used only by consumer
+| dataStoreClass | common |  | String | dataStore type
+| endKey | common |  | Object | Gora Query End Key attribute
+| endTime | common |  | long | Gora Query End Time attribute
+| fields | common |  | Strings | Gora Query Fields attribute
+| flushOnEveryOperation | common | true | boolean | Flush on every operation NOTE: used only
by producer
+| hadoopConfiguration | common |  | Configuration | configuration
+| keyClass | common |  | String | key type
+| keyRangeFrom | common |  | Object | Gora Query Key Range From attribute
+| keyRangeTo | common |  | Object | Gora Query Key Range To attribute
+| limit | common |  | long | Gora Query Limit attribute
+| startKey | common |  | Object | Gora Query Start Key attribute
+| startTime | common |  | long | Gora Query Start Time attribute
+| timeRangeFrom | common |  | long | Gora Query Time Range From attribute
+| timeRangeTo | common |  | long | Gora Query Key Range To attribute
+| timestamp | common |  | long | Gora Query Timestamp attribute
+| valueClass | common |  | String | value type
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the
Camel routing Error Handler which mean any exceptions occurred while the consumer is trying
to pickup incoming messages or the likes will now be processed as a message and handled by
the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler
to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) |  | ExceptionHandler | To let the consumer use
a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options
is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR
level and ignored.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern
when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+// endpoint options: END
+
+
+[[Gora-SupportedGoraOperations]]
+Supported Gora Operations
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Supported operations include : *put*, *get*, *delete*, *getSchemaName*,
+*deleteSchema*, *createSchema*, *query*, *deleteByQuery*,
+*schemaExists*.
+
+Some of the operations require arguments while some others no. The
+arguments to operations could be either the _body_ of the _in_ message
+or defined in a header property. Below there is a list with some
+additional info for each operation.
+
+[width="100%",cols="10%,90%",options="header",]
+|=======================================================================
+|Property |Description
+
+|put |_Inserts the persistent object with the given key._
+
+|get |_Returns the object corresponding to the given key fetching all the
+fields._
+
+|delete |_Deletes the object with the given key._
+
+|getSchemaName |_Returns the schema name given to this DataStore._
+
+|deleteSchema |_Deletes the underlying schema or table (or similar) in the datastore
+that holds the objects._
+
+|createSchema |_Creates the optional schema or table (or similar) in the datastore to
+hold the objects._
+
+|query |_Executes the given query and returns the results._
+
+|deleteByQuery |_Deletes all the objects matching the query._
+
+|schemaExists |_Returns whether the schema that holds the data exists in the
+datastore._
+|=======================================================================
+
+[[Gora-GoraHeaders]]
+Gora Headers
+^^^^^^^^^^^^
+
+[width="100%",cols="20%,80%",options="header",]
+|=======================================================================
+|Property |Description
+
+|GoraOperation |_Used in order to define the operation to execute._
+
+|GoraKey | _Used in order to define the datum key for the operations need it._
+|=======================================================================
+
+[[Gora-Usageexamples]]
+Usage examples
+^^^^^^^^^^^^^^
+
+*Create Schema* _(XML DSL)_:
+
+[source,xml]
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+<setHeader headerName="GoraOperation">
+ <constant>CreateSchema</constant>
+</setHeader>
+<to uri="gora:foobar?keyClass=java.lang.Long&amp;valueClass=org.apache.camel.component.gora.generated.Pageview&amp;dataStoreClass=org.apache.gora.hbase.store.HBaseStore"/>
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+*SchemaExists* _(XML DSL)_:
+
+[source,xml]
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+<setHeader headerName="GoraOperation">
+ <constant>SchemaExists</constant>
+</setHeader>
+ <to uri="gora:foobar?keyClass=java.lang.Long&amp;valueClass=org.apache.camel.component.gora.generated.Pageview&amp;dataStoreClass=org.apache.gora.hbase.store.HBaseStore"/>
+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+*Put* _(XML DSL)_:
+
+[source,xml]
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+<setHeader headerName="GoraOperation">
+ <constant>put</constant>
+</setHeader>
+<setHeader headerName="GoraKey">
+ <constant>22222</constant>
+</setHeader>
+<to uri="gora:foo?keyClass=java.lang.Long&amp;valueClass=org.apache.camel.component.gora.generated.Pageview&amp;dataStoreClass=org.apache.gora.hbase.store.HBaseStore"/>
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+*Get* _(XML DSL)_:
+
+[source,xml]
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+<setHeader headerName="GoraOperation">
+ <constant>GET</constant>
+</setHeader>
+<setHeader headerName="GoraKey">
+ <constant>10101</constant>
+</setHeader>
+<to uri="gora:bar?keyClass=java.lang.Long&amp;valueClass=org.apache.camel.component.gora.generated.Pageview&amp;dataStoreClass=org.apache.gora.hbase.store.HBaseStore"/>
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+*Delete* _(XML DSL)_:
+
+[source,xml]
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+<setHeader headerName="GoraOperation">
+ <constant>DELETE</constant>
+</setHeader>
+<setHeader headerName="GoraKey">
+ <constant>22222</constant>
+</setHeader>
+<to uri="gora:bar?keyClass=java.lang.Long&amp;valueClass=org.apache.camel.component.gora.generated.Pageview&amp;dataStoreClass=org.apache.gora.hbase.store.HBaseStore"/>
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+*Query* _(XML DSL)_:
+
+[source,xml]
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+<to uri="gora:foobar?keyClass=java.lang.Long&amp;valueClass=org.apache.camel.component.gora.generated.Pageview&amp;dataStoreClass=org.apache.gora.hbase.store.HBaseStore"/>
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+The full usage examples in the form of integration tests can be found at
+https://github.com/ipolyzos/camel-gora-examples/[camel-gora-examples]
+repository.
+
+[[Gora-Moreresources]]
+More resources
+^^^^^^^^^^^^^^
+
+For more please information and in depth configuration refer to the
+http://gora.apache.org/current/overview.html[Apache Gora Documentation]
+and the http://gora.apache.org/current/tutorial.html[Apache Gora
+Tutorial].

http://git-wip-us.apache.org/repos/asf/camel/blob/34eb77f2/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 8003d6a..abae3ea 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -139,6 +139,7 @@
     * [Google Calendar](google-calendar.adoc)
     * [Google Drive](google-drive.adoc)
     * [Google Mail](google-mail.adoc)
+    * [Gora](gora.adoc)
     * [Ironmq](ironmq.adoc)
     * [JMS](jms.adoc)
     * [JMX](jmx.adoc)


Mime
View raw message