| class | method/attribute | parameters | keys for params | returns | description |
| AggregationResult | get(type) | type Type | Object | Returns the aggregation result | |
| Container | create_index(params) | params Hash | column_name
String index_type IndexType name String Default value: index_type=DEFAULT, name=nil |
Creates a specified type of index on the specified Column | |
| drop_index(params) | params Hash | column_name
String index_type IndexType name String Default value: index_type=DEFAULT, name=nil |
Removes the specified type of index among indexes on the specified Column | ||
| flush() | Writes the results of earlier updates to a non-volatile storage medium, such as SSD, so as to prevent the data loss even if all cluster nodes stop suddenly | ||||
| put(row) | row Array(Object) | true, false | Newly creates or update a Row | ||
| query(query) | query String | Query | Creates a query to execute the specified TQL statement | ||
| abort() | Rolls back the result of the current transaction and starts a new transaction in the manual commit mode | ||||
| commit() | Commits the result of the current transaction and start a new transaction in the manual commit mode | ||||
| set_auto_commit(enabled) | enabled true, false | Change the setting of the commit mode | |||
| get(key) | key Object | Array(Object) | Returns the content of a Row corresponding to Row key | ||
| remove(key) | key Object | true, false | Deletes a Row corresponding to Row key | ||
| type | Integer attribute (Read only) | ||||
| QueryAnalysisEntry | get() | Array | Returns one of information entries composing a query plan and the results of analyzing a query operation | ||
| GSException | get_error_stack_size() | Integer | Returns the stack size of last error information related to specified resource | ||
| get_error_code(stack_index) | stack_index Integer | Integer | Returns the error code of last error related to specified resource | ||
| get_message(stack_index) | stack_index Integer | String | Returns the message of last error related to specified resource | ||
| what() | String | Returns the message include error code and error message | |||
| get_location(stack_index) | stack_index Integer | String | Returns the error location of the internal module to the message of last error related to specified resource | ||
| Query | fetch(for_update=false) | for_update true, false | RowSet | Executes a specified query with the specified option and returns a set of Rows as an execution result | |
| get_row_set() | RowSet | Returns RowSet as the latest result | |||
| set_fetch_options(params) | params Hash | limit
int partial boolean Default value: limit=INTEGER_MAX, partial=false |
Sets an fetch option for a result acquisition | ||
| RowSet | remove() | Deletes the Row at the current cursor position | |||
| next() | AggregationResult or Array(Object) | Moves the cursor to the next element in a object set and returns the object at the moved position | |||
| has_next() | true, false | Returns whether a Row set has at least one Row ahead of the current cursor position | |||
| update(row) | row Array(Object) | Updates the values except a Row key of the Row at the cursor position, using the specified Row object | |||
| type | Integer attribute (Read only) | ||||
| size | Integer attribute (Read only) | ||||
| Store | put_container(info, modifiable = false) | info
ContainerInfo modifiable true, false |
Container | Newly creates or update a Container with the specified Container properties | |
| get_container(name) | name String | Container | Get a Container instance whose rows can be processed using a Row object | ||
| drop_container(name) | name String | Delete a Container with the specified name | |||
| get_container_info(name) | name String | ContainerInfo | Get information related to a Container with the specified name | ||
| StoreFactory | self.get_instance() | StoreFactory | Returns a default StoreFactory instance | ||
| get_store(params) | params Hash | host
String port Integer cluster_name String database String username String password String notification_member String norification_provider String |
Store | Returns
a Store with the specified properties Note: If this host is multicast address, host/port means notificationAddress/notificationPort for C Client. |
|
| get_version() | String | Returns the current version of client | |||
| ContainerInfo | ContainerInfo(params) |
params Hash | name
String column_info_aray Array(Array(String, Type)) type ContainerType row_key boolean expiration ExpirationInfo Default value: type=COLLECTION, row_key=true, expiration=nil |
ContainerInfo | Constructor |
| name | String attribute | ||||
| column_info_list | Array(Array(String, Type)) attribute | ||||
| type | Integer attribute | ||||
| row_key | true, false attribute | ||||
| expiration | ExpirationInfo attribute | ||||
| ExpirationInfo | ExpirationInfo(time, unit, division_count) | time Integer unit TimeUnit division_count Integer |
ExpirationInfo | Constructor | |
| time | Integer attribute | ||||
| unit | Integer attribute | ||||
| division_count | Integer attribute | ||||
| TimestampUtils | self.get_time_millis(timestamp) | timestamp Float | Integer | Caluculate int-type timestamp in millisecond from nanosecond get from Time object | |