norikra-client-jruby 0.0.9-java → 0.1.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 742acdfe054dfdb6cce4b55d94fcea2fae7179d5
-  data.tar.gz: 0cc945ef6b4deed710cfc883c584bad0a8909824
+  metadata.gz: 10de160e6bd3033f77a96ede852709beead02f7f
+  data.tar.gz: 4e1e01377dc51eec87228bf840f466b43df87f9b
 SHA512:
-  metadata.gz: 14aa9b34b25f7efc0af012416431836972420b21da13f0589ebc7cfe43253bb573c67a9be45a06f93f9fb84975e2bb5d89072452bf357eea07be7311925bd2a0
-  data.tar.gz: b1b2ddabd14eb7b9d898daadbc1c8f71d394f57aec6320976e497a85a0a26591081eb9da42feed3523bcd92f0a878ce8f6e5cf78068b72cb17ad54fd9e32f4a2
+  metadata.gz: e59b012082cef26e8c780e78271781aef4d65a60e6120e880dcd791cbfd06fb5b8572b78c7c9ae63165758595d07cb8978fa366a46bc3fb6650c346c8403e657
+  data.tar.gz: 2383ce078a4532bef29bd68d2538ddfbd98901e6e48414d52ea090d91174bfc70c2b5b1956ed26d0867ed64018e83ae276f0d23cdb1bd529e38db43317348dae

data/README.md

@@ -3,7 +3,7 @@
 This is the client library implementation for Norikra, and its handy CLI commands.
 
 `Norikra` is CEP server, based on Esper. You can install `gem install norikra` on your JRuby.
-For more information, see https://github.com/tagomoris/norikra .
+For more information, see http://norikra.github.io .
 
 Command `norikra-client` and module `Norikra::Client` are provided for both of CRuby and JRuby.
 
@@ -19,10 +19,11 @@ Command `norikra-client` have some subcommands.
     norikra-client -h
     Commands:
       norikra-client event CMD ...ARGS    # send/fetch events
-      norikra-client help [COMMAND]       # Describe available commands or one specific command
       norikra-client query CMD ...ARGS    # manage queries
       norikra-client target CMD ...ARGS   # manage targets
-      norikra-client typedef CMD ...ARGS  # manage table field/datatype definitions
+      norikra-client field CMD ...ARGS  # manage table field/datatype definitions
+      
+      norikra-client help [COMMAND]       # Describe available commands or one specific command
     
     Options:
       [--host=HOST]
@@ -41,17 +42,130 @@ In your programs, you can operate Norikra with Norikra::Client instances.
     client = Norikra::Client.new     # connect to localhost:26571
     # client = Norikra::Client.new(hostname, portnum)
 
-### Instance methods
+## API
 
-TBD
+### Norikra::Client.new(host, port, options={})
 
-## Versions
+Instanciate with server's hostname and port number.
+
+    require 'norikra-client'
+    client = Norikra::Client.new('norikra.server.local', 26571)
+
+Timeout options are available:
+
+    client = Norikra::Client.new(
+        'norikra.server.local',
+        26571,
+        connect_timeout: 3, send_timeout: 1, receive_timeout: 3
+    )
+
+### Norikra::Client#targets
+
+Returns list of hashes, which contains `name`(string) and `auto_fields`(true/false) of each targets.
+
+    client.targets #=> [{'name' => "demo", 'auto_field' => false}, {'name' => "sample", 'auto_field' => true}]
+
+### Norikra::Client#open(target_name, fields=nil, auto_field=true)
+
+Create new target on norikra server, to put events and queries. Returns true or false (successfully created, or already exists).
+
+    client.open('sample') #=> true
+
+Without fields, the specified target will be opend as 'lazy' mode, and actually opend when first input event arrived. Default field set will be determined at that time.
+
+With field definitions, `#open()` creates the target and actually opens it immediately.
+
+    client.open('sample', {id:'long', name:'string', age:'int', email:'string'})
+
+Fiels specified on `#open()` are configured as default field set.
+
+`auto_field` means which fields in arrived events are automatically added on field list, or not. Default is true.
+`auto_field: true` helps you to know What fields input event streams have. You can watch fields list on norikra, and write queries. But in cases your input streams have great many field name patterns, norikra returns long list of field names. That is not understandable. In these cases, you should specify `auto_field false`.
+
+In spite of `auto_field false`, norikra server adds fields which are used in registered queries automatically.
+
+### Norikra::Client#close
+
+Close the specified target. Norikra server stops all queries with that target.
+
+    client.close('sample')   #=> true
+
+### Norikra::Client#modify(target_name, auto_field)
+
+Modify the specified target configuration of auto_field.
+
+    client.modify('sample', false)   #=> true
+
+### Norikra::Client#queries
+
+Returns a list of hashes which contains `name`, `group`, `expression` and `targets` of registered queries.
 
-TBD
+    client.queries #=> [{'name' => 'q1', 'group' => nil, 'expression' => 'select count(*) from sample ...', 'targets' => ['sample']}]
 
-## TODO
+Attributes of query:
+  * `name`: the name of query, that must be unique on norikra server
+  * `group`: the group name of query to be used in `sweep` call to fetch all events of queries with same `group` name (nil: default)
+  * `expression`: SQL expression
+  * `targets`: list of targets, which are referred in this SQL (2 or more targets by JOINs and SubQueries)
+
+### Norikra::Client#register(query_name, query_group, query_expression)
+
+Add query to norikra server. Query will be started immediately if all required targets/fields exists. If not, query actually starts when events arrived with all required fields.
+
+    client.register('q1', nil, 'select count(*) from sample.win:time_batch(1 min) where age >= 20')  #=> true
+
+### Norikra::Client#deregister(query_name)
+
+Stop and remove specified query immediately.
+
+    client.deregister('q1')   #=> true
+
+### Norikra::Client#fields(target)
+
+Returns the list of fields definitions, which contains `name`(string), `type`(string) and `optional`(true/false).
+
+    client.fields('sample') #=> [{'name' => 'id', 'type' => 'int', 'optional' => false}, ...]
+
+NOTE: Hashes and arrays are just returned as 'hash' and 'array'. Nested fields and these types are not returned to client.
+
+### Norikra::Client#reserve(target, field_name, type)
+
+Specify the type of field, which not arrived yet.
+
+    client.reserve('sample', 'phone', 'string')  #=> true
+
+This api is useful for fields, which has int data at a time, and has string data at the other time. Norikra determines fields' type at the first time with that field, and format input data by determined type.
+If you want to parse as int for a field but that field's value may be either String or Integer, you should do `reserve()` to determine it as `int`.
+
+### Norikra::Client#send(target, events)
+
+Send list of input events into norikra server.
+
+    client.send('sample', [record1, record2, record3])
+
+Members of events should be hash instance, which has a field at least.
+Field values must be able to be serialized with MessagePack. Safe with String, Integer, Float, true/false/nil, Hash and Array.
+
+### Norikra::Client#event(query_name)
+
+Fetch events of specified query's output. Returns a list of `[time, event]`.
+
+    client.event('q1') #=> [ [1383297109,{"count(*)":50}], [1383297169,{"count(*)":37}], ... ]
+
+The first value of returned pairs is the time of output event as unix time (seconds from epoch).
+The second value is output record of query as Hash.
+
+### Norikra::Client#sweep(query_group=nil)
+
+Fetch all output events of queries of specified group. `query_group: nil` means default query group. Returns Hash instance like `'query_name' => [list of output (same as #event)]`
+
+    client.fetch() #=> for default group
+    client.fetch('my_secret_group')
+
+## Versions
 
-* TBD
+* v0.1.0:
+ * First release for production
 
 ## Copyright
 

data/lib/norikra/client/version.rb

@@ -1,5 +1,5 @@
 module Norikra
   class Client
-    VERSION = "0.0.9"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: norikra-client-jruby
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: java
 authors:
 - TAGOMORI Satoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack-rpc-over-http-jruby