Revision: 3689
 

Welcome to NodeJS Client’s documentation!

NodeJS Client for GridDB is developed using GridDB C Client and SWIG (http://www.swig.org/).

Functions are the following:

(available)

  • STRING, BOOL, BYTE, SHORT, INTEGER, LONG, FLOAT, DOUBLE, TIMESTAMP, BLOB type for GridDB
  • Put/get data
  • Normal query, aggregation with TQL
  • Multi-Put/Get/Query (batch processing)
  • Promise method
  • null

(not available)

  • GEOMETRY type for GridDB
  • Timeseries compression
  • Timeseries-specific function like gsAggregateTimeSeries, gsQueryByTimeSeriesSampling in C Client
  • Trigger, affinity

Please refer to GridDB API reference about Data-type and TQL.

Note:

  • null is used to represent the absence of a value.
  • Accuracy of TIMESTAMP for GridDB is in milliseconds. It is the same as return value of Date.getTime().

back to top ⇧

AggregationResult

Stores the result of an aggregation operation.
The type of the stored result depends on the type of aggregation operation and the type of the target Columns. For specific rules, see the TQL specifications.
The type of obtaining value depends on the stored type. Float type and long type are only available when a result is of numeric type, and datetime type when a result is of TIMESTAMP type.

Constructor

new AggregationResult()

Members (2)

timestampOutput :boolean

Get output type for row field timestamp.
The default of output timestsamp is datatime.

timestampOutput :void

Set output type for row field timestamp.
The default of output timestsamp is datatime.

Methods (1)

get(type) → {object}

Returns the aggregation result as the value with specified type.

Parameters:
Name Type Description
type Type Column type
back to top ⇧

Container

CProvides management functions for sets of row having same type.
Each column in GridDB schema is defined by a ContainerInfo. Each container consists of one or more columns.
Mapping table between column type and value in a row object is following:

(Column) TypestringbooleannumberDateBuffer
STRINGmapped
BOOL mappedmapped
BYTE mapped
SHORT mapped
INTEGER mapped
LONG mapped
FLOAT mapped
DOUBLE mapped
TIMESTAMPmapped mappedmapped
BLOB mapped

TIMESTAMP represents milliseconds since the UNIX epoch (January 1, 1970 00:00:00 UTC) with long type.
TIMESTAMP value suports msec. Range of time is from 1/1/1970 to 12/31/9999 (UTC). There may be more limitation depending on a GridDB cluster configuration. Cannot store a value out of the range.
There is an upper limit for the number of column and the length of column name. The value has limitations for rage and size. Please refer to appendix of GridDB API Reference for more detail. Cannot store a value exceeding these limitations.
A limitation about a row key type, presence of column corresponding to a row key, and availability of row value updates, may differ for each type derived from the container type.
NULL in GridDB rows can be retained unless the NOT NULL constraint is set. NOT NULL constraint can be set with columnInfoList object in ContainerInfo when put_container() is called.
About transaction, auto commit mode is active as a default. In the auto commit mode, each transaction is processed sequentially, and cannot be canceled. For manual commit mode, transactions before a commit is canceled if there is an error on a cluster node during the transaction via Container instances. Transaction isolation level supports only READ COMMITTED. Lock granularity may differ for each container type.
When a row is updated, added, deleted, and got a lock for updates, a transaction is generated internally. This transaction has a valid period. After some period defined by GridDB is passed from the timing of this transaction for Container instance, any same type of transactions will be not accepted.

Constructor

new Container()

Properties:
Name Type Default Description
type ContainerType 0 Container type

Members (4)

timestampOutput :void

Set output type for row field timestamp.
The default of output timestsamp is datatime.

timestampOutput :boolean

Get output type for row field timestamp.
The default of output timestsamp is datatime.

type :ContainerType

Get type of Container

type :void

Set type for Container

Methods (13)

abort() → {Promise.<void>}

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

close() → {Promise.<void>}

Disconnects with GridDB and releases related resources as necessary.

closeSync() → {void}

Disconnects with GridDB and releases related resources as necessary.

commit() → {Promise.<void>}

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

createIndex(indexInfo) → {Promise.<void>}

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.

Parameters:
Name Type Description
indexInfo object Index information
Properties
Name Type Default Description
columnName string Column name to be processed
indexType IndexType DEFAULT Type of index
name string null Name of index

dropIndex(indexInfo) → {Promise.<void>}

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.

Parameters:
Name Type Description
indexInfo object Index information
Properties
Name Type Default Description
columnName string Column name to create index
indexType IndexType DEFAULT Type of index
name string null Name of index

flush() → {Promise.<void>}

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.

get(key, forUpdate) → {Promise.<object>}

Returns the content of a Row corresponding to Row key.

Parameters:
Name Type Description
key object Row key to be processed
forUpdate boolean Indicates whether it requests a lock for update or not

multiPut(rowList) → {Promise.<void>}

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.

Parameters:
Name Type Description
rowList Array. List object corresponding to contents of newly created Row collection

put(row) → {Promise.<boolean>}

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.

Parameters:
Name Type Default Description
row Array.<object> null A list object representing the content of a Row to be newly created or updated.

query(query) → {Query}

Creates a query to execute the specified TQL statement.

Parameters:
Name Type Description
query string TQL statement.

remove(key) → {Promise.<boolean>}

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

Parameters:
Name Type Description
key object Row key to be processed

setAutoCommit(enabled)

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.

Parameters:
Name Type Description
enabled boolean Indicates whether it enables auto commit mode or not. if True, auto commit mode is enabled. if False, manual commit mode is enabled.
back to top ⇧

GSException

Represents the exception for GridDB.

Constructor

new GSException()

Properties:
Name Type Default Description
isTimeout boolean false Read-only attribute to 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

Methods (7)

close() → {void}

Disconnects with GridDB and releases related resources as necessary.

getErrorCode(stackIndex) → {number}

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

Parameters:
Name Type Description
stackIndex number The index of error stack. A valid result will be returned only if a value which has more than 0 and less than the stack size is specified.

getErrorStackSize() → {number}

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.

getLocation(stackIndex) → {string}

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.

Parameters:
Name Type Description
stackIndex number The index of error stack. A valid result will be returned only if a value which has more than 0 and less than the stack size is specified.

getMessage(stackIndex) → {string}

Returns the message of last error related to this resource.

Parameters:
Name Type Description
stackIndex number The index of error stack. A valid result will be returned only if a value which has more than 0 and less than the stack size is specified.

isTimeout() → {boolean}

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.

what() → {string}

Returns the message include error code and error message

back to top ⇧

PartitionController

Controller for acquiring and processing the partition status.
A partition is a theoretical region where data is stored. It is used to perform operations based on the data arrangement in a GridDB cluster.

Constructor

new PartitionController()

Properties:
Name Type Default Description
partitionCount number null The number of partitions in the target GridDB cluster. (Read-only attribute)

Members (1)

partitionCount :number

Get partition count
Get the number of partitions in the target GridDB cluster.

Methods (5)

close() → {Promise.<void>}

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

closeSync()

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

getContainerCount(partitionIndex) → {Promise.<number>}

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.

Parameters:
Name Type Description
partitionIndex number The partition index, from 0 to the number of partitions minus one

getContainerNames(partitionIndex, start, limit) → {Promise.<Array.<string>>}

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.

Parameters:
Name Type Description
partitionIndex number The partition index, from 0 to the number of partitions minus one
start number The start position of the acquisition range. A value must be greater than or equal to 0
limit number The upper limit of the number of cases acquired. It is optional. If not specified or limit < 0, it is considered as no upper limit.

getPartitionIndexOfContainer(containerName) → {Promise.<number>}

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.

Parameters:
Name Type Description
containerName string Container name
back to top ⇧

Query

Provides the functions of holding the information about a query related to a specific Container, specifying the options for fetching and retrieving the result.

Constructor

new Query()

Methods (5)

close() → {Promise.<void>}

Releases related resources properly.

closeSync() → {void}

Releases related resources properly.

fetch() → {Promise.<RowSet>}

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.

getRowSet() → {RowSet}

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

setFetchOptions(options)

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

Parameters:
Name Type Description
options object The options for fetching the result of a query
Properties
Name Type Default Description
limit number null Used to set the maximum number of Rows to be fetched
back to top ⇧

QueryAnalysisEntry

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

Constructor

new QueryAnalysisEntry()

Methods (1)

get() → {Array}

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

back to top ⇧

RowKeyPredicate

Represents the condition that a row key satisfies.
This is used as the search condition in Store.multiGet().
There are two types of conditions, range condition and individual condition. The two types of conditions cannot be specified at the same time. If the condition is not specified, it means that the condition is satisfied in all the target row keys.

Constructor

new RowKeyPredicate()

Properties:
Name Type Description
keyType Type The type of Row key used as a search condition. (Read-only attribute)

Members (2)

keyType :void

Set type of RowkeyPredicate

keyType :Type

Get type of RowkeyPredicate

Methods (4)

getDistinctKeys() → {Array.<object>}

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

getRange() → {Array.<object, object>}

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

setDistinctKeys(keys)

Sets list of the elements in the individual condition.

Parameters:
Name Type Description
keys Array.<object> List of the elements in the individual condition

setRange(start, end)

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

Parameters:
Name Type Description
start object The value of the Row key as the start position
end object The value of the Row key as the end position
back to top ⇧

RowSet

Manages a set of Rows obtained by a query.
It has a function of per-Row and per-Row-field manipulation and holds a cursor state to specify a target Row. The cursor is initially located just before the head of a Row set.

Constructor

new RowSet()

Properties:
Name Type Default Description
type RowSetType CONTAINER_ROWS The type of content that can be extracted from RowSet. (Read-only attribute)
size number null The size of Row set. (Read-only attribute)

Members (4)

size :number

Get size of row set
The number of Row when a Row set is created

timestampOutput :boolean

Get output type for row field timestamp.
The default of output timestsamp is datatime.

timestampOutput :void

Set output type for row field timestamp.
The default of output timestsamp is datatime.

type :RowSetType

Get type of row set

Methods (4)

close() → {Promise.<void>}

Releases related resources as necessary.

closeSync()

Releases related resources as necessary.

hasNext() → {boolean}

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

next() → {Array.<object>|AggregationResult|QueryAnalysisEntry}

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

back to top ⇧

Store

Provides functions to manipulate the entire data managed in one GridDB system.
A function to add, delete, or change the composition of Collection and TimeSeries Containers as well as to process the Rows constituting a Container is provided.
Regardless of container types, etc., multiple container names different only in uppercase and lowercase ASCII characters cannot be defined in a database. See the GridDB Technical Reference for the details. In the operations specifying a container name, uppercase and lowercase ASCII characters are identified as the same unless otherwise noted.
Thread safety of each method is not guaranteed.

Constructor

new Store()

Properties:
Name Type Description
partitionController PartitionController PartitionController instance corresponding to GridDB cluster. (Read-only attribute)

Members (3)

partitionController :PartitionController

Get PartitionController corresponding to GridDB cluster.
It can be used until the specified GSGridStore is closed.

timestampOutput :boolean

Get output type for row field timestamp.
The default of output timestsamp is datatime.

timestampOutput :void

Set output type for row field timestamp.
The default of output timestsamp is datatime.

Methods (11)

close() → {Promise.<void>}

Disconnects with GridDB without releases related resources.

closeSync() → {void}

Disconnects with GridDB without releases related resources (synchronously).

createRowKeyPredicate(type) → {Promise.<RowKeyPredicate>}

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.

Parameters:
Name Type Description
type Type The type of Row key used as a matching condition.

createRowKeyPredicateSync(type) → {RowKeyPredicate}

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.

Parameters:
Name Type Description
type Type The type of Row key used as a matching condition.

dropContainer(name) → {Promise.<void>}

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.

Parameters:
Name Type Description
name string Container name to be processed.

fetchAll(queryList) → {Promise.<void>}

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.

Parameters:
Name Type Description
queryList Array.<Query> A list of target Queries

getContainer(name) → {Promise.<Container>}

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

Parameters:
Name Type Description
name string Container name to be processed

getContainerInfo(name) → {Promise.<ContainerInfo>}

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.

Parameters:
Name Type Description
name string Container name to be processed.

multiGet(predicateEntry) → {object.<string, Array.<object>>}

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.

Parameters:
Name Type Description
predicateEntry object.<string, RowKeyPredicate> The column of condition entry consisting of a combination of the target Container name and the acquisition condition. It consists of the array of RowKeyPredicate.

multiPut(containerEntry) → {Promise.<void>}

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.

Parameters:
Name Type Description
containerEntry object.<string, Array.<Array.<object>>> dict-type data consisting of container name and the list of Row objects

putContainer(info, modifiable) → {Promise.<Container>}

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

Parameters:
Name Type Default Description
info ContainerInfo Container information to be processed.
modifiable boolean false Indicates whether the column layout of the existing Container can be modified or not.
back to top ⇧

StoreFactory

Manage a Store instance.
It manages the client settings shared by Store instances and used connections.
To access GridDB, you need to get a Store instance using this Factory.

Constructor

new StoreFactory()

Methods (3)

(static) getInstance() → {StoreFactory}

Returns a StoreFactory instance.

getStore(options) → {Store}

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.

Parameters:
Name Type Description
options object Information to get store.
Properties
Name Type Default Description
host string null A destination host name.
port number null A destination port number.
clusterName string null A cluster name.
database string null Name of the database to be connected.
username string null A user name.
password string null A password for user authentication.
notificationMember string null A list of address and port pairs in cluster.
notificationProvider string null A URL of address provider.

getVersion() → {string}

Returns the version of this client.

back to top ⇧

Members (6)

(constant) ContainerType :ContainerType

Represents the type of a Container.
Properties:
Name Type Description
COLLECTION ContainerType Collection container
TIME_SERIES ContainerType TimeSeries container

(constant) IndexType :IndexType

Represents the type(s) of indexes set on a Container.
If DEFAULT is specified, the following types of indexes are selected depending on the Container type and corresponding Column type.

(Column) TypeCollectionTimeSeries
STRINGTREETREE
BOOLTREETREE
Numeric typeTREETREE
TIMESTAMPTREETREE
BLOB(-)(-)

Properties:
Name Type Description
DEFAULT IndexType Indicates a default index.
TREE IndexType Indicates a tree index. This index can be applied to STRING/BOOL/BYTE/SHORT/INTEGER/LONG/FLOAT/DOUBLE/TIMESTAMP types of Columns of any type of Container, except the Column corresponding to the Row key of TimeSeries.
HASH IndexType Indicates a hash index. This type of index can be set on STRING/BOOL/BYTE/SHORT/INTEGER/LONG/FLOAT/DOUBLE/TIMESTAMP types of Columns in Collection. It cannot be set on Columns in TimeSeries.

(constant) RowSetType :RowSetType

Represents the type of content that can be extracted from RowSet.
Properties:
Name Type Description
CONTAINER_ROWS RowSetType Row set in a Container
AGGREGATION_RESULT RowSetType Aggregation result
QUERY_ANALYSIS RowSetType Represents one of information entries composing a query plan and the results of analyzing a query operation.

(constant) TimeUnit :TimeUnit

Represents the unit of the elapsed time period of a Row to be used as the basis of the validity period.
Properties:
Name Type Description
YEAR TimeUnit
MONTH TimeUnit
DAY TimeUnit
HOUR TimeUnit
MINUTE TimeUnit
SECOND TimeUnit
MILLISECOND TimeUnit

(constant) Type :Type

Represents the type of field values in GridDB.
Properties:
Name Type Description
STRING Type STRING type
BOOL Type BOOL type
BYTE Type BYTE type
SHORT Type SHORT type
INTEGER Type INTEGER type
LONG Type LONG type
FLOAT Type FLOAT type
DOUBLE Type DOUBLE type
TIMESTAMP Type TIMESTAMP type
BLOB Type BLOB type

(constant) TypeOption :TypeOption

Represents NOT NULL constrant.
Properties:
Name Type Description
NULLABLE TypeOption NULLABLE. Indicates a Column without NOT NULL constraint.
NOT_NULL TypeOption NOT NULL. Indicates a Column with NOT NULL constraint.
back to top ⇧

griddb_nodejs