Welcome to NodeJS Client’s documentation!

Returns the aggregation result as the value with specified type.

Rolls back the result of the current transaction and starts a new transaction in the manual commit mode.

Disconnects with GridDB and releases related resources as necessary.

Disconnects with GridDB and releases related resources as necessary.

Commits the result of the current transaction and start a new transaction in the manual commit mode.

Creates a specified type of index on the specified Column.
Named index can be set with name parameter.
No index cannot be set on a TimeSeries Row key (TIMESTAMP type).
When a transaction is held, uncommitted updates will be rolled back.
If an index is already set on the specified Column, nothing is changed.
When a transaction(s) is active in a target Container, it creates an index after waiting for the transaction(s) to complete.

Removes the specified type of index among indexes on the specified Column.
Nothing is changed if the specified index is not found.
When a transaction(s) is active in a target Container, it removes the index after waiting for the transaction(s) to be completed.

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.
It can be used for operations which require higher reliability than usual. However, frequent execution of this operation would potentially cause degradation in response time.
The details of behavior, such as the scope of cluster nodes which are the data export targets, will be changed depending on the configuration of GridDB.

Returns the content of a Row corresponding to Row key.

Newly creates an arbitrary number of Rows together based on the specified Row objects group.
In the manual commit mode, the target Row is locked.

Newly creates or update a Row.
If a Column exists which corresponds to the specified Row key, it determines whether to newly create or update a Row, based on the Row key and the state of the Container. If there is no corresponding Row in the Container, it determines to newly create a Row; otherwise, it updates a relevant Row.
If no Column exists which corresponds to the specified Row key, it always creates a new Row.
In the manual commit mode, the target Row is locked.

Creates a query to execute the specified TQL statement.

Removes a Row corresponding to Row key.
In the manual commit mode, the target Row is locked.

Change the setting of the commit mode.
In the auto commit mode, the transaction state cannot be controlled directly and change operations are committed sequentially. If the auto commit mode is disabled, i.e. in the manual commit mode, as long as the transaction has not timed out or commit() has been invoked directly, the same transaction will continue to be used in this Container and change operations will not be committed.
When the auto commit mode is switched from disabled to enabled, uncommitted updates are committed implicitly. Unless the commit mode is changed, the state of the transaction will not be changed.

Disconnects with GridDB and releases related resources as necessary.

Returns the error code of last error related to this resource.
0 indicates the successful execution for GridDB instructions.

Returns the stack size of last error information related to this resource.
Error information has become a stack structure. A large stack number corresponds to the more direct cause of the error.

Returns the error location of the internal module to the message of last error related to this resource.
It might always return empty string depending on the settings.

Returns the message of last error related to this resource.

Determine whether the result of the requested process shows the error code corresponding to the error that occurred when the requested process is not completed within a predetermined time.

Returns the message include error code and error message

The connection status with GridDB is released and related resources are released where necessary.

The connection status with GridDB is released and related resources are released where necessary.

Get the total number of containers belonging to a specified partition.
The calculated quantity when determining the number of containers is generally not dependent on the number of containers.

Get a list of the Container names belonging to a specified partition.
For the specified partition, the sequence of the list of acquisition results before and after will not be changed when the relevant Container is excluded even if a Container is newly created, its composition changed or the Container is deleted. All other lists are compiled in no particular order. No duplicate names will be included.
If the upper limit of the number of acquisition cases is specified, the cases will be cut off starting from the ones at the back if the upper limit is exceeded. If no relevant specified condition exists, a blank list is returned.

Get the partition index corresponding to the specified Container name.
Once a GridDB cluster is constructed, there will not be any changes in the partitions of the destination that the Container belongs to and the partition index will also be fixed. Whether there is a Container corresponding to the specified name or not does not depend on the results.
Information required in the computation of the partition index is cached and until the next cluster failure and cluster node failure is detected, no inquiry will be sent to the GridDB cluster again.

Releases related resources properly.

Releases related resources properly.

It locks all target Rows if True is specified as forUpdate . If the target Rows are locked, update operations on the Rows by any other transactions are blocked while a relevant transaction is active. True can be specified only if the auto commit mode is disabled on a relevant Container.
When new set of Rows are obtained, any Row operation via RowSet as the last result of specified query is prohibited.
If the system tries to acquire a large number of Rows all at once, the upper limit of the communication buffer size managed by the GridDB node may be reached, possibly resulting in a failure. Refer to "System limiting values" in the Appendix of GridDB API Reference for the upper limit size.

Returns RowSet as the latest result.
Once RowSet is returned, it cannot be obtained until the new query is executed.

Sets an fetch options for a result acquisition.
Once RowSet is returned, it cannot be obtained until the new query is executed.

Returns one of information entries composing a query plan and the results of analyzing a query operation.

Returns a list of the values of the Row keys that configure the individual condition.

Returns the value of Row key at the start and end position of the range condition.

Sets list of the elements in the individual condition.

Sets the value of Row key as the start and end position of the range conditions.

Releases related resources as necessary.

Releases related resources as necessary.

Returns whether a Row set has at least one Row ahead of the current cursor position.

Moves the cursor to the next Row in a Row set and returns the Row object at the moved position.

Disconnects with GridDB without releases related resources.

Disconnects with GridDB without releases related resources (synchronously).

Creates a matching condition with the specified Type as the type of Row key.
The target Container must have a Row key, and it must be the same type as the specified Type.
The type of Row key that can be set must be the same type that is allowed by the individual Container type derived from Container.

Creates a matching condition with the specified Type as the type of Row key (synchronously).
The target Container must have a Row key, and it must be the same type as the specified Type.
The type of Row key that can be set must be the same type that is allowed by the individual Container type derived from Container.

Delete a Container with the specified name.
If the specified Container is already deleted, nothing is changed.
When a transaction(s) is active in a target Container, it deletes the Container after waiting for the transaction completion.

Query execution and fetch is carried out on a specified arbitrary number of Query , with the request unit enlarged as much as possible.
For each Query included in a specified query column, perform a similar query execution and fetch as when Query.fetch() is performed individually and set the RowSet in the results. Use getRowSet() to extract the execution results of each Query . However, unlike the case when carried out individually, the target node is requested for the same storage destination, etc. with a unit that is as large as possible. Based on this, the larger the number of elements in the list, the higher is the possibility that the number of correspondences with the target node will be reduced. Query in a list are not executed in any particular order.
Only a Query that has not been closed, including corresponding Container acquired via the specified Store instance, can be included in a specified query column. Like a fetch() , the Row operations via RowSet finally generated and held by each Query will be unavailable. If the same instance is included multiple times in an array, the behavior will be the same as the case in which the respective instances differ.
Like other Container or Row operations, consistency between Containers is not guaranteed. Therefore, the processing results for a certain Container may be affected by other operation commands that have been completed prior to the start of the process.
The commit mode of each Container corresponding to the specified Query can be used in either the auto commit mode or manual commit mode. The transaction status is reflected in the execution results of the query. If the operation is completed normally, the corresponding transaction of each Container will not be aborted so long as the transaction timeout time has not been reached.
If an exception occurs in the midst of processing each Query , a new RowSet may be set for only some of the Query . In addition, uncommitted transactions of each Query corresponding to the designated Container may be aborted.
If the system tries to acquire a large number of Rows all at once, the upper limit of the communication buffer size managed by the GridDB node may be reached, possibly resulting in a failure. Refer to "System limiting values" in the Appendix of GridDB API Reference for the upper limit size.

Get a Container instance whose Rows can be processed using a Row.

Get information related to a Container with the specified name.
A name stored in GridDB is set for the Container name to be included in a returned ContainerInfo . Therefore, compared to the specified Container name, the notation of the ASCII uppercase characters and lowercase characters may differ.
When a transaction(s) is active in a target Container, it deletes the Container after waiting for the transaction completion.

Returns an arbitrary number and range of Rows in any Container based on the specified conditions, with the request unit enlarged as much as possible.
Returns the Row contents in accordance with the conditions included in the specified entry column, similar to invoking Container.get() or Query.fetch() individually. However, unlike the case when carried out individually, the target node is requested for the same storage destination, etc. with a unit that is as large as possible. Based on this, the larger the total number of Rows conforming to the conditions and the larger the total number of target Containers, the higher is the possibility that the number of correspondences with the target node will be reduced.
A specified condition entry column is composed of an arbitrary number of condition entries that adopt the Container name as the key and the acquisition condition represented by RowKeyPredicate as the value. Multiple instances with the same RowKeyPredicate can also be included. In addition, a subject Container may be a mixture of different Container types and column layouts. However, there are some acquisition conditions that cannot be evaluated due to the composition of the Container. Refer to the definitions of the various setting functions for RowKeyPredicate for the specific restrictions. In addition, the specified Container name must be a real Container. It is prohibited to set null in the Container name or the acquisition condition.
An acquired entry column is composed of entries that adopt the Container name as its key and column of Row objects as its value. All entries included in a specified entry as acquisition conditions are included in an acquired entry column. If multiple entries pointing the same Container are included in a specified condition entry column, a single entry consolidating these is stored in the acquired entry column. If multiple Row objects are included in the same list, the stored order follows the Container type and the definition of the individual Container type derived from the corresponding Container . If there is no Row corresponding to the specified Container, the number of elements in corresponding column of Row object will be 0.
Like other Container or Row operations, consistency between Containers is not guaranteed. Therefore, the processing results for a certain Container may be affected by other operation commands that have been completed prior to the start of the process.
Like Container.get() or Query.fetch() , a transaction cannot be maintained and requests for updating locks cannot be made.
If the system tries to acquire a large number of Rows all at once, the upper limit of the communication buffer size managed by the GridDB node may be reached, possibly resulting in a failure. Refer to "System limiting values" in the Appendix of GridDB API Reference for the upper limit size.

New creation or update operation is carried out on an arbitrary number of rows of a Container, with the request unit enlarged as much as possible.
For each Row object included in a specified entry column, a new creation or update operation is carried out just like the case when Container.put() is invoked individually. However, unlike the case when carried out individually, the target node is requested for the same storage destination, etc. with a unit that is as large as possible. Based on this, the larger the total number of Row objects specified and the larger the total number of target Containers, the higher is the possibility that the number of correspondences with the target node will be reduced.
A specified entry column is composed of an arbitrary number of entries that adopt the Container name as its key and the column of Row objects as its value. A subject Container may be a mixture of different Container types and column layouts. However, the Containers must already exist. Null can not be set as the Container name in the entry column. Also null can not be set as the array address to the column of Row objects if the number of elements in the column of Row objects is positive value.
An arbitrary number of Row with the same column layout as the subject Container can be included in each column of Row objects. In the current version, all the column order must also be the same. The Container cannot include null as an element of the column of Row objects. Depending on the Container type and setting, the same restrictions as Container.put() are established for the contents of Rows that can be operated. If there are multiple columns of Row objects having the same Row key targeting the same Container in the designated entry column, the contents of the rear-most Row object having a Row key with the same value will be reflected using the element order of entry column as a reference if it is between different lists, or the element order of the column of Row object as a reference if it is within the same column of Row object. The transaction cannot be maintained and the lock cannot continue to be retained. However, if the lock that affects the target Row is secured by an existing transaction, the system will continue to wait for all the locks to be released. Like other Container or Row operations, consistency between Containers is not guaranteed. Therefore, the processing results for a certain Container may be affected by other operation commands that have been completed prior to the start of the process. If an error occurs in the midst of processing a Container and its Rows, only the results for some of the Rows of some of the Containers may remain reflected.

Newly creates or update a Container with the specified ContainerInfo.
It can be used only for RowSet obtained with locking enabled.

Returns a StoreFactory instance.

Returns a Store with the specified properties.
When obtaining Store, it just searches for the name of a master node (hereafter, a master) administering each Container as necessary, but authentication is not performed. When a client really needs to connect to a node corresponding to each Container , authentication is performed.
A new Store instance is created by each call of this method. Operations on different Store instances and related resources are thread safe. That is, if some two resources are each created based on Store instances or they are just Store instances, and if they are related to different Store instances respectively, any function related to one resource can be called, no matter when a function related to the other resource may be called from any thread. However, since thread safety is not guaranteed for Store itself, it is not allowed to call a method of a single Store instance from two or more threads at an arbitrary time.

Returns the version of this client.