Enum Constant Detail

• AVERAGE

  public static final Aggregation AVERAGE

  An operation to obtain an average.

  Available only to numeric-type Columns. The type of a returned value is always DOUBLE. If no target Row exists, the aggregation result will not be stored in a result object.

• COUNT

  public static final Aggregation COUNT

  An operation to obtain the number of samples, i.e., the number of Rows.

  Available to any kinds of Columns. The type of a returned value is always LONG. If no target Row exists, the aggregation result will not be stored in a result object.

• MAXIMUM

  public static final Aggregation MAXIMUM

  An operation to obtain a maximum value.

  Available only to Columns of numeric and time types allowing magnitude comparison. The type of a returned value is the same as that of a specified Column. If no target Row exists, the aggregation result will not be stored in a result object.

• MINIMUM

  public static final Aggregation MINIMUM

  An operation to obtain a minimum value.

  Available only to Columns of numeric and time types allowing magnitude comparison. The type of a returned value is the same as that of a specified Column. If no target Row exists, the aggregation result will not be stored in a result object.

• STANDARD_DEVIATION

  public static final Aggregation STANDARD_DEVIATION

  An operation to obtain a standard deviation.

  Available only to numeric-type Columns. The type of a returned value is always DOUBLE. If no target Row exists, the aggregation result will not be stored in a result object.

• TOTAL

  public static final Aggregation TOTAL

  An operation to obtain a sum total.

  Available only to numeric-type Columns. The type of a returned value is LONG if a specified Column is of integer type, and DOUBLE if it is of floating-point type. If no target Row exists, the aggregation result will not be stored in a result object.

• VARIANCE

  public static final Aggregation VARIANCE

  An operation to obtain a variance.

  Available only to numeric-type Columns. The type of a returned value is always DOUBLE. If no target Row exists, the aggregation result will not be stored in a result object.

• WEIGHTED_AVERAGE

  public static final Aggregation WEIGHTED_AVERAGE

  An operation to obtain a weighted average.

  The weighted average is calculated by dividing the sum of products of sample values and their respective weighted values by the sum of weighted values. For the method of calculating a weighted value, see the description of Aggregation.

  This operation is only available to numeric-type Columns. The type of a returned value is always DOUBLE. If no target Row exists, the aggregation result will not be stored in a result object.

Method Detail

• valueOf

  public static Aggregation valueOf(java.lang.String name)

  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

  Parameters:

  name - the name of the enum constant to be returned.

  Returns:

  the enum constant with the specified name

  Throws:

  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

  java.lang.NullPointerException - if the argument is null

• values

  public static Aggregation[] values()

  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

  for (Aggregation c : Aggregation.values())
      System.out.println(c);
  

  Returns:

  an array containing the constants of this enum type, in the order they are declared

Method Detail

• getDouble

  java.lang.Double getDouble()

  Obtains the result of aggregating numeric-type values in DOUBLE type (Double).

  It returns null if a result is not of numeric type. If a result is not of DOUBLE type, it returns the value converted to DOUBLE.

  Returns:

  Result of aggregating DOUBLE type (Double). If the type of result is different, returns null.

• getLong

  java.lang.Long getLong()

  Obtains the result of aggregating numeric-type values in LONG type (Long).

  It returns null if a result is not of numeric type. If a result is not of LONG type, it returns the value converted to LONG.

  Returns:

  Result of aggregating LONG type (Long). If the type of result is different, returns null.

• getPreciseTimestamp

  java.sql.Timestamp getPreciseTimestamp()

  Retrieves the result of aggregating time-type values as high-precision TIMESTAMP type (Timestamp) values.

  If non-TIMESTAMP type values are retained, null is returned.

  If normal-precision TIMESTAMP values are retained, they are converted to high-precision values and then returned.

  Returns:

  Result of aggregating high-precision TIMESTAMP type (Timestamp) values.

  Since:

  5.3

• getTimestamp

  java.util.Date getTimestamp()

  Retrieves the result of aggregating time-type values as normal -precision TIMESTAMP type (Date) values.

  It returns null if a result is not of TIMESTAMP type.

  If high-precision TIMESTAMP values are retained, they are converted to normal-precision values and then returned.

  Returns:

  Result of aggregating normal-precision TIMESTAMP type (Date) values. If the type of result is different, returns null.

Method Detail

• noKeyOf

  public static <R> Container.BindType<java.lang.Void,R,? extends Collection<java.lang.Void,R>> noKeyOf(java.lang.Class<R> rowClass)
                                                                                             throws GSException

  Returns the Container.BindType, which has no Row key, associated with the specified Row object type and the Collection.

  Type Parameters:

  R - Type of Row object

  Parameters:

  rowClass - Class object corresponding to the type of the Row object

  Throws:

  GSException - if an inconsistency is detected between the type of Row key and the type of Row object

  Since:

  4.3

• of

  public static <K,R> Container.BindType<K,R,? extends Collection<K,R>> of(java.lang.Class<K> keyClass,
                                                           java.lang.Class<R> rowClass)
                                                              throws GSException

  Returns the specified Row key type, the specified Row object type, and Container.BindType associated with the Collection.

  Type Parameters:

  K - Type of Row key

  R - Type of Row object

  Parameters:

  keyClass - Class object corresponding to the type of Row key

  rowClass - Class object corresponding to the type of the Row object

  Throws:

  GSException - if an inconsistency is detected between the type of Row key and the type of Row object

  Since:

  4.3

• of

  public static <K,R extends Row.WithKey<K>> Container.BindType<K,R,? extends Collection<K,R>> of(java.lang.Class<R> rowClass)
                                                                                                            throws GSException

  Returns the Row key type obtained from the specified Row object type, the specified Row object type, and Container.BindType associated with the Collection.

  Type Parameters:

  K - Type of Row key

  R - Type of Row object

  Parameters:

  rowClass - Class object corresponding to the type of the Row object

  Throws:

  GSException - if the Row key type cannot be obtained from the specified Row object type

  Since:

  4.3

Method Detail

• query

  Query<R> query(java.lang.String column,
               Geometry geometryIntersection,
               Geometry geometryDisjoint)
                 throws GSException

  Creates a query to obtain a set of Rows which are matched to specified geometry range conditions with exclusion range.

  Obtains a set of Rows which has the column values that intersect with geometryIntersection and do not intersect with geometryDisjoint. Conditions of the intersection determination is the same as the GeometryOperator.INTERSECT.

  When obtaining a set of Rows using Query.fetch(boolean), the option of locking for update can be enabled.

  In the current version, NullPointerException will not be dispatched when GSException and null cannot be specified as null. If there is an error in the column name, etc., an exception is thrown when the obtained query is fetched.

  Parameters:

  column - A name of the geometry type column to be compared. null cannot be specified

  geometryIntersection - Geometry structure indicating a range that intersects with the value on the column. null cannot be specified

  geometryDisjoint - Geometry structure indicating a range that does not intersect with the values on the column. null cannot be specified

  Throws:

  GSException - It will not be thrown in the current version.

• query

  Query<R> query(java.lang.String column,
               Geometry geometry,
               GeometryOperator geometryOp)
                 throws GSException

  Creates a query to obtain a set of Rows which are matched to specified geometry range conditions.

  When obtaining a set of Rows using Query.fetch(boolean), the option of locking for update can be enabled.

  GSException will not be thrown in the current version. If there is an error such as column names, exception will be thrown when fetching the obtained query.

  In the current version, NullPointerException will not be dispatched when GSException and null cannot be specified as null. If there is an error in the column name, etc., an exception is thrown when the obtained query is fetched.

  Parameters:

  column - A name of the geometry type column to be compared. null cannot be specified

  geometry - Geometry structure to be compared. null cannot be specified

  geometryOp - Comparison method. null cannot be specified

  Throws:

  GSException - It will not be thrown in the current version.

Constructor Detail

• ColumnInfo.Builder

  public ColumnInfo.Builder()

  Constructs a builder where none of the elements is specified.

• ColumnInfo.Builder

  public ColumnInfo.Builder(ColumnInfo info)

  Constructs a builder where all the specified ColumnInfo elements are set.

  Parameters:

  info - Column information including what is set to the builder

  Throws:

  java.lang.NullPointerException - If null is specified as an argument

Method Detail

• set

  public ColumnInfo.Builder set(ColumnInfo info)

  Sets all the specified ColumnInfo elements.

  If the specified ColumnInfo contains an item in which nothing is set, nothing will be set to the corresponding items in the builder regardless of the original settings of this builder.

  Parameters:

  info - Column information including what is set to the builder

  Returns:

  this builder

  Throws:

  java.lang.NullPointerException - If null is specified as an argument

• setDefaultValueNull

  public ColumnInfo.Builder setDefaultValueNull(java.lang.Boolean defaultValueNull)

  Sets whether to use NULL as an initial value of a column.

  If the specified argument is null, nothing is set.

  Parameters:

  defaultValueNull - whether to use NULL as an initial value of a column.

  Returns:

  this builder

  See Also:

  ColumnInfo.getDefaultValueNull()

• setIndexTypes

  public ColumnInfo.Builder setIndexTypes(java.util.Set<IndexType> indexTypes)

  Sets a set of index types.

  If the specified argument is null, nothing is set.

  Parameters:

  indexTypes - a set of index types

  Returns:

  this builder

  See Also:

  ColumnInfo.getIndexTypes()

• setName

  public ColumnInfo.Builder setName(java.lang.String name)

  Sets a column name.

  If the specified argument is null, nothing is set.

  Parameters:

  name - column name

  Returns:

  this builder

  See Also:

  ColumnInfo.getName()

• setNullable

  public ColumnInfo.Builder setNullable(java.lang.Boolean nullable)

  Sets whether NOT NULL constraints are placed in a column.

  If the specified argument is null, nothing is set.

  Parameters:

  nullable - whether NOT NULL constraints are placed in a column.

  Returns:

  this builder

  See Also:

  ColumnInfo.getNullable()

• setTimePrecision

  public ColumnInfo.Builder setTimePrecision(TimeUnit timePrecision)

  Sets date/time precision.

  If the specified argument is null, nothing is set.

  Parameters:

  timePrecision - date/time precision

  Returns:

  this builder

  See Also:

  ColumnInfo.getTimePrecision()

• setType

  public ColumnInfo.Builder setType(GSType type)

  Sets a column type.

  If the specified argument is null, nothing is set.

  Parameters:

  type - column type

  Returns:

  this builder

  See Also:

  ColumnInfo.getType()

• toInfo

  public ColumnInfo toInfo()

  Constructs ColumnInfo based on what is set in this builder.

  Column information to be returned will never change even when the settings of this builder are modified after construction.

  Returns:

  column information

Constructor Detail

• ColumnInfo

  public ColumnInfo(java.lang.String name,
            GSType type)

  Constructs column information with the specified column name and type.

  Parameters:

  name - Column name. Not set when null is specified.

  type - Column type. Not set when null is specified.

• ColumnInfo

  public ColumnInfo(java.lang.String name,
            GSType type,
            java.lang.Boolean nullable,
            java.lang.Boolean defaultValueNull,
            java.util.Set<IndexType> indexTypes)

  Constructs column information with specifying the column name, type, whether to use of NULL for the initial value, NOT NULL constraint state, and set of index types.

  If a set of not empty index types is specified, the contents are duplicated.

  Parameters:

  name - Column name. Not set when null is specified.

  type - Column type. Not set when null is specified.

  defaultValueNull - true if the initial value is set to NULL. false if the initial value is set to non-NULL. Not set when null is specified.

  nullable - true if NOT NULL constraint is not set. false if it is set. Not set when null is specified.

  indexTypes - A set of index types. Not set when null is specified. No index type is set if empty set is specified.

  Since:

  4.1

• ColumnInfo

  public ColumnInfo(java.lang.String name,
            GSType type,
            java.lang.Boolean nullable,
            java.util.Set<IndexType> indexTypes)

  Constructs column information with the column name, type, NOT NULL constraint state, and set of index types.

  If a set of not empty index types is specified, the contents are duplicated.

  Parameters:

  name - Column name. Not set when null is specified.

  type - Column type. Not set when null is specified.

  nullable - true if NOT NULL constraint is not set. false if it is set. Not set when null is specified.

  indexTypes - A set of index types. Not set when null is specified. No index type is set if empty set is specified.

  Since:

  3.5

• ColumnInfo

  public ColumnInfo(java.lang.String name,
            GSType type,
            java.util.Set<IndexType> indexTypes)

  Constructs column information with the specified column name, type, and set of index types.

  If a set of not empty index types is specified, the contents are duplicated.

  Parameters:

  name - Column name. Not set when null is specified.

  type - Column type. Not set when null is specified.

  indexTypes - A set of index types. Not set when null is specified. No index type is set if empty set is specified.

Method Detail

• getDefaultValueNull

  public java.lang.Boolean getDefaultValueNull()

  Returns whether to use of NULL for the initial value.

  Returns:

  true if the initial value is set to NULL. false if the initial value is set to non-NULL. null if not specified.

  Since:

  4.1

• getIndexTypes

  public java.util.Set<IndexType> getIndexTypes()

  Returns all of set of index type.

  UnsupportedOperationException can occur when value of the returned object is updated. And value of the returned object is not changed by updating this object.

  Returns:

  Set of index type, or null if unspecified.

• getName

  public java.lang.String getName()

  Returns a name of column.

  Returns:

  Name of column, or null if unspecified.

• getNullable

  public java.lang.Boolean getNullable()

  Returns the value irrespective to NOT NULL constraint is set in the column or not.

  Returns:

  true if the NOT NULL constraint is not set, false if set. If not set null.

  Since:

  3.5

• getTimePrecision

  public TimeUnit getTimePrecision()

  Retrieves the date/time precision of this column.

  In the current version, the following combination of column types and date/time precision can be used in defining a Container.

  column type	date/time precision
  TIMESTAMP type	TimeUnit.MILLISECOND TimeUnit.MICROSECOND TimeUnit.NANOSECOND null (interpreted as if TimeUnit.MILLISECOND is specified)
  non-TIMESTAMP type	null

  Use ColumnInfo.Builder to construct ColumnInfo with the date/time precision specified.

  Returns:

  date/time precision; if not set, null.

  Since:

  5.3

• getType

  public GSType getType()

  Returns the type of a column, i.e., the type of each field value corresponding to a column.

  Returns:

  Type of column, or null if unspecified.

Enum Constant Detail

• HI

  public static final CompressionMethod HI

  Represents a thinning compression with error

  In this type of compression, values that represent gradient same as before and immediately after may be thinned. The algorithm to determine the equality of the gradients can be specified by users. Only if specified column meets the above conditions and other columns are the same as the last registered data, the row is thinned. The thinned value is recovered in an interpolation or sampling processing within the specified error range.

• NO

  public static final CompressionMethod NO

  Represents no compression.

• SS

  public static final CompressionMethod SS

  Represents a thinning compression without error

  In this type of compression, rows that have the same value registered immediately before and after are thinned. The thinned values are recovered in the interpolation or sampling processing without information loss.

Method Detail

• valueOf

  public static CompressionMethod valueOf(java.lang.String name)

  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

  Parameters:

  name - the name of the enum constant to be returned.

  Returns:

  the enum constant with the specified name

  Throws:

  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

  java.lang.NullPointerException - if the argument is null

• values

  public static CompressionMethod[] values()

  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

  for (CompressionMethod c : CompressionMethod.values())
      System.out.println(c);
  

  Returns:

  an array containing the constants of this enum type, in the order they are declared

Method Detail

• castContainer

  public C castContainer(Container<?,?> container)
                                         throws GSException

  Casts to the type of Container or its subinterface that has the type of Row key and the type of Row object held by this object as type parameters.

  Parameters:

  container - the Container instance to be casted

  Returns:

  Casted object

  Throws:

  GSException - if the type of Row key and the type of Row object do not match between the Container instance to be casted and the type information held by this object

  Since:

  4.3

• castKey

  public K castKey(java.lang.Object obj)

  Casts to the type of the Row key held by this object.

  Parameters:

  obj - The object to cast

  Returns:

  Casted object

  Since:

  4.3

• castRow

  public R castRow(java.lang.Object obj)

  Casts to the type of the Row object held by this object.

  Parameters:

  obj - The object to cast

  Returns:

  Casted object

  Since:

  4.3

• getContainerClass

  public java.lang.Class<? extends Container<?,?>> getContainerClass()

  Returns the type of Container or its subinterface.

  Returns:

  The type of Container or its subinterfaces that are expected to be implemented in the corresponding Container instance

  Since:

  4.3

• getKeyClass

  public java.lang.Class<K> getKeyClass()

  Returns the type of the Row key.

  Returns:

  Type of Row key

  Since:

  4.3

• getRowClass

  public java.lang.Class<R> getRowClass()

  Returns the type of the Row object.

  Returns:

  Type of Row object

  Since:

  4.3

• noKeyOf

  public static <R> Container.BindType<java.lang.Void,R,? extends Container<java.lang.Void,R>> noKeyOf(java.lang.Class<R> rowClass)
                                                                                            throws GSException

  Returns the Container.BindType, which has no Row key, associated with the specified Row object type and Container of any type.

  Type Parameters:

  R - Type of Row object

  Parameters:

  rowClass - Class object corresponding to the type of the Row object

  Returns:

  corresponding type information

  Throws:

  GSException - if an inconsistency is detected between the type of Row key and the type of Row object

  Since:

  4.3

• of

  public static <K,R> Container.BindType<K,R,? extends Container<K,R>> of(java.lang.Class<K> keyClass,
                                                          java.lang.Class<R> rowClass)
                                                             throws GSException

  Returns the Container.BindType associated with the specified Row key type, the specified Row object type, and Container of any type.

  Type Parameters:

  K - Type of Row key

  R - Type of Row object

  Parameters:

  keyClass - Class object corresponding to the type of Row key

  rowClass - Class object corresponding to the type of the Row object

  Returns:

  corresponding type information

  Throws:

  GSException - if an inconsistency is detected between the type of Row key and the type of Row object

  Since:

  4.3

• of

  public static <K,R extends Row.WithKey<K>> Container.BindType<K,R,? extends Container<K,R>> of(java.lang.Class<R> rowClass)
                                                                                                           throws GSException

  Returns the Container.BindType associated with the Row key type obtained from the specified Row object type, the specified Row object type, and Container of any type.

  Type Parameters:

  K - Type of Row key

  R - Type of Row object

  Parameters:

  rowClass - Class object corresponding to the type of the Row object

  Returns:

  corresponding type information

  Throws:

  GSException - if the Row key type cannot be obtained from the specified Row object type

  Since:

  4.3

Method Detail

• abort

  void abort()
             throws GSException

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

  Throws:

  GSException - if called not in the autocommit mode.

  GSException - if a timeout occurs during this operation or the transaction, this Container is deleted or a connection failure occurs; or if called after the connection is closed.

• close

  void close()
             throws GSException

  Disconnects with GridDB and releases related resources as necessary.

  When a transaction is held, uncommitted updates will be rolled back.

  Even if GSException is thrown, the connection and local resources will be released properly. However, the transaction state might remain in GridDB. If the transaction is already closed, no release operation is invoked by this method.

  Specified by:

  close in interface java.lang.AutoCloseable

  Specified by:

  close in interface java.io.Closeable

  Throws:

  GSException - if a connection failure occurs

• commit

  void commit()
              throws GSException

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

  Throws:

  GSException - if called not in the autocommit mode

  GSException - if a timeout occurs during this operation or the transaction, this Container is deleted or a connection failure occurs; or if called after the connection is closed.

• createBlob

  java.sql.Blob createBlob()
                           throws GSException

  Creates a Blob to store a large size of binary data for a Container.

  The created Blob can be used as a Row field. First, set binary data in the Blob using Blob.setBinaryStream(long) etc. and then store it in Container using put(Object) etc.

  At least the following methods can be called on the Blob obtained by this method.

  • Blob.length()
  • Blob.setBinaryStream(long)
  • Blob.setBytes(long, byte[])
  • Blob.setBytes(long, byte[], int, int)
  • Blob.free()

  You do not have to use the Blob created by this method as BLOB to be set on a Row object. You can set an instance of other class implementing Blob, such as SerialBlob. The created Blob does not have any validity period.

  In the current version, since the entire Row is cached in memory, it might be impossible to store larger data than the maximum VM memory size.

  GSException will not be thrown in the current version.

  Throws:

  GSException

• createIndex

  void createIndex(IndexInfo info)
                   throws GSException

  Create an index according to the contents set in IndexInfo.

  For the column of the index to be created, at least one of the column name sequence and column number sequence must be set, and the actual column must be set in the corresponding container. If both are set, corresponding columns and its order must match each other.

  If the index type is not set or IndexType.DEFAULT is set, the default index type is selected according to the criteria described below.

  If an index name is set, a new index is created only if there is no index with the same name or the different name only in upper- or lowercase letters in the target container. See the GridDB Features Reference for the details. In defining an index name, there are limits on the allowed characters and the length. In the operations of index, the names are not case-sensitive unless otherwise noted.

  If a name index gets duplicated, you must specify the same setting IndexInfo that satisfies the conditions described below, in which case no new index will be created. On the other hand, you can not specify an existing IndexInfo that has the same name as an index with a different name or an unnamed index.

  If an index name is not set, it is assumed that creation of an unnamed index was requested. If an identical index already exists (excluding name), it must be an unnamed index, which in this case no new index will be created.

  In the current version, an index created through Container is considered to be the same set of indexes except for index names if the following conditions are satisfied.

  • The columns to be indexed must match, including its order. Differences in column specification methods, such as column name sequence, column number sequence and single column are ignored.
  • The index types must match. Differences in the specification method of index type such as existence of default designation are ignored.

  In the current version, for the Container instance generated based on (), the following index type is selected as default based on the type of container, the type of corresponding column, etc.

  Column type	collection	time series
  STRING	IndexType.TREE	IndexType.TREE
  BOOL	IndexType.TREE	IndexType.TREE
  NUMERAL	IndexType.TREE	IndexType.TREE
  TIMESTAMP	IndexType.TREE	IndexType.TREE Note:restriction applies
  GEOMETRY	IndexType.SPATIAL	(-)
  BLOB	(-)	(-)
  ARRAY	(-)	(-)

  An Index cannot be set for Time Series Row Keys (TIMESTAMP type). These index types cannot be selected if the default type differs depending on the column type that configures the column.

  If this Container instance holds an uncommitted transaction, commit before create. Container to be processed. If there are other transactions being executed at the same time, wait for them to finish before creating. If an index already exists and no new index is created, it is undefined whether to wait by another transaction. In this case, it is undefined whether uncommitted transactions held by this Container instance are always committed or not.

  In the current version, in the case of satisfying the conditions such as the size of the container, during creating an index, the reference of the container information, a part of the index operations, the trigger operations, and the row operations (including the update of rows) may be performed. Under the definition of Container, other operations may be waited. For the operations during the index creation, the container information doesn't include the index information to be created.

  Throws:

  GSException - When the column or index name to be created does not conform to the above rule

  GSException - If this process's timeout, deletion of this container or schema change, connection failure occurs, or when called after closing

  GSException - When an unsupported index type is specified in the specified column

  java.lang.NullPointerException - when null is specified as argument

  Since:

  3.5

• createIndex

  void createIndex(java.lang.String columnName)
                   throws GSException

  Creates an unnamed index with default type for the column with the specified name.

  Behaves the same as calling createIndex(IndexInfo) with IndexInfo with only the column name set.

  Throws:

  GSException - If the specified column name does not conform to the rule of createIndex(IndexInfo)

  GSException - if a timeout occurs during this operation, this Container is deleted, its schema is changed or a connection failure occurs; or if called after the connection is closed.

  GSException - if indexing is not supported on the specified Column.

  java.lang.NullPointerException - if a null parameter is specified.

• createIndex

  void createIndex(java.lang.String columnName,
                 IndexType type)
                   throws GSException

  Creates an unnamed index with the specified type for the column with the specified name.

  Behaves the same as calling createIndex(IndexInfo) with IndexInfo with only the column name and type set.

  Throws:

  GSException - If the specified column name and type does not conform to the rule of createIndex(IndexInfo)

  GSException - if a timeout occurs during this operation, this Container is deleted, its schema is changed or a connection failure occurs; or if called after the connection is closed.

  GSException - if the specified type of index is not supported on the specified Column type.

  java.lang.NullPointerException - if a null parameter(s) is specified.

• createRow

  R createRow()
              throws GSException

  Create a new Row object based on the column layout of this Container.

  If the Row object type of the Container is Row, a fixed default value is set in each field of the Row to be created, similar to the case when it is created using a GridStore.createRow(ContainerInfo). In this case, the operation on the created Row also does not affect whether this Container object is closed or not.

  Throws:

  GSException - If an exclusion is sent out when creating a user-defined Row object

  GSException - If invoked after being closed

• createTrigger

  void createTrigger(TriggerInfo info)
                     throws GSException

  Set the trigger.

  If a update operation of a specific type is carried out on this Container, a notification will be sent to the specified URI. If a trigger with the same name as the specified trigger exists, the setting will be overwritten.

  Refer to the definition of TriggerInfo for the detailed trigger settings. The details of the trigger name, the trigger type, notification conditions, notification destination URI and notification contents are as shown below.

  Trigger name

  Multiple trigger names which are identified as the same, including the names only different in ASCII uppercase and lowercase characters, even if they have different types or notification conditions, in a container cannot be defined. And there are the limitations, the allowed characters and the length, on the trigger names. See the GridDB Features Reference for the details. Trigger names are case-sensitive unless otherwise noted.

  Trigger type

  The following trigger types are supported.

  name	description
  REST	Trigger to notify the specified URI with a REST notification (HTTP POST method) when an update operation of the specified type is carried out on a Container.
  Java Message Service(JMS)	Trigger to send a JMS message to the JMS server of the specified URI when an update operation of the specified type is carried out on a Container. Apache ActiveMQ is used as the JMS provider.

  Notification condition

  Create new Row/ update Row for this Container (put(Object), put(Object, Object), put(java.util.Collection), GridStore.multiPut(java.util.Map), RowSet.update(Object)), delete (remove(Object), RowSet.remove()) Perform notification immediately after executing operation command. If multiple operations are specified as monitoring targets, perform notification after executing any one of these operations.

  Completion of replication at the point notification is carried out is not guaranteed. For notifications corresponding to a create new Row/ update Row or delete command that has been executed by disabling the auto commit mode, if the transaction is not committed at the point of the notification, or if the transaction is aborted after the notification, it may not be possible to get the data included in the notification at the point the notification is received.

  For batch operations involving multiple Rows, notification is carried out for each Row operation. If there is no response within a specified time even if notification has been sent to the specified URl, time out is performed and it will not be sent again. If a failure occurs in a GridDB cluster, in addition to not sending any notification to support a certain update operation, multiple notifications may be sent.

  Notification destination URI

  A notification destination URI is described in the following format.

   (method name)://(host name):(port number)/(path)

  However, if the trigger type is REST, only http can be specified in the method name.

  Notification contents

  Provide notification of the updated Container name, update operation name, and specified column value of the updated Row data. For the update operation name, use "put" to create a new Row/ update Row and "delete" to delete.

  The notification value shall be the specified column value of the Row data that is newly created immediately after a new Row is created, or updated in an update operation, or before deletion in a delete operation. If the column type is TIMESTAMP, an integer to indicate the time passed in milliseconds starting from 1970-01-01T00:00:00Z is set as the value. If the column type if BLOB, GEOMETRY, or array, a blank character string will be set as the value.

  Notification method - For REST

  JSON character strings such as those shown below are sent with the MIME type application/json.

   {
     "container" : "(container name)",
     "event" : "(update operation name)",
     "row" : {
       "(column name)" : (column data),
       "(column name)" : (column data),
       ...
     }
   }

  Notification method - For JMS

  A javax.jms.TextMessage is sent with the specified destination type and destination name.

  The container name is set by javax.jms.Message#setStringProperty("@container", "(container name)"). The update operation name is set by javax.jms.Message#setStringProperty("@event", "(update operation name)").

  The column value is set with a javax.jms.Message#setXXXProperty("(column name)", (column data)) in accordance with the column type.

  When the column layout is changed by a GridStore.putCollection(String, Class, boolean), GridStore.putTimeSeries(String, Class, TimeSeriesProperties, boolean), etc. in relation to a Container with a set trigger, if a column subject to trigger notification is deleted or if its name is changed, the corresponding column will be deleted from the trigger notification targets.

  If the server does not respond to a request sent to the notification destination URI that has been set up when sending a notification from GridDB, standby processing will occur until the process times out. This standby process becomes a cause for the delay in serving notification of an update in the Container as well as some other containers. Therefore, a trigger having an invalid notification destination URI is recommended to be deleted by using dropTrigger(String).

  See the GridDB Features Reference for the maximum number of triggers that can be set for a single Container and the upper limit of the values for various trigger settings.

  Parameters:

  info - Trigger information of the setting target

  Throws:

  GSException - If the trigger name is null, blank, or does not follow to other rules

  GSException - If the update operation subject to monitoring is not specified

  GSException - If the notification destination URI does not conform to the stipulated syntax

  GSException - If the JMS is specified by the trigger type, and the JMS destination type is null, or is blank, or does not conform to the specified format

  GSException - If the JMS is specified by the trigger type, and the JMS destination name is null, or is blank

  GSException - If the JMS is specified by the trigger type, and the JMS destination name is null, or is blank

  java.lang.NullPointerException - If null is specified in the argument

  Since:

  1.5

• dropIndex

  void dropIndex(IndexInfo info)
                 throws GSException

  Delete all indexes that match the content set in IndexInfo.

  The setting information of IndexInfo are used as a condition to narrow down the index to be deleted. Filtering conditions are classified into three categories: column sequence, index type, and index name. Setting each of them is optional. If none of them are set, all created indexes are deleted.

  If a column name sequence or column number sequence is set, it must exist in the corresponding container. If both column name sequence and column number sequence are set, corresponding columns must match each other. If neither the column name sequence nor the column number sequence is set, the index for any column sequence that satisfies other refinement conditions (index type, index name) will be deleted.

  When the index type is set, only the index of the specified type will be deleted. If IndexType.DEFAULT is set, the default type index is selected according to the standard of createIndex(IndexInfo). Columns that do not support indexes and columns that do not support indexes of the specified type are not eligible for deletion. If the index type is not set, index that fulfil the conditions (column sequence, index name) will be deleted.

  If an index name is set, only the index with the specified name will be deleted. The identity of the index name follows the criteria of createIndex(IndexInfo). If an index name is not set, an index with an arbitrary name and an unnamed index that fulfils the conditions (column sequence, index type) will be deleted.

  If there is no index to be deleted, the index will not get deleted.

  Transaction handling is similar to createIndex(IndexInfo). Also, it is undefined whether or not other transactions may be executed while only a few indexes are deleted when multiple indexes are subject to deletion.

  The immediate state after completion of the index deletion request is similar to GridStore.dropContainer(String).

  Throws:

  GSException - if the column or index name to be deleted does not conform to the above rule

  GSException - if the process is timeout, deletion of this container or schema change, connection failure occurs, or called after closing

  java.lang.NullPointerException - when null is specified as argument

  Since:

  3.5

• dropIndex

  void dropIndex(java.lang.String columnName)
                 throws GSException

  Delete only the default type index from the column with the specified name.

  Behaves the same as calling dropIndex(IndexInfo) with IndexInfo with column name and default type set.

  Throws:

  GSException - When the specified column name does not conform to the rule of dropIndex(IndexInfo)

  GSException - if a timeout occurs during this operation, this Container is deleted, its schema is changed or a connection failure occurs; or if called after the connection is closed.

  java.lang.NullPointerException - if a null parameter is specified.

• dropIndex

  void dropIndex(java.lang.String columnName,
               IndexType type)
                 throws GSException

  Deletes only the index of the specified type from the column with the specified name.

  Behaves the same as calling dropIndex(IndexInfo) with IndexInfo with column name and type set.

  Throws:

  GSException - when the specified column name does not conform to the rule of dropIndex(IndexInfo)

  GSException - if a timeout occurs during this operation, this Container is deleted, its schema is changed or a connection failure occurs; or if called after the connection is closed.

  java.lang.NullPointerException - if null is specified as more than one parameter.

• dropTrigger

  void dropTrigger(java.lang.String name)
                   throws GSException

  Delete a trigger.

  Nothing is changed if the trigger of the specified name does not exist.

  Throws:

  GSException - If this process times out, this Container is deleted, a connection failure were to occur, or if it is invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument

• flush

  void flush()
             throws GSException

  Writes the results of earlier updates to a non-volatile storage medium, such as SSD, so as to prevent the data from being lost even if all cluster nodes stop suddenly.

  It can be used for operations requiring higher reliability than normal. However, frequent execution of this would cause degradation in response time.

  Its behaviors vary, such as the scope of cluster nodes concerned, depending on the configuration of GridDB.

  Throws:

  GSException - if a timeout occurs during this operation, this Container is deleted or a connection failure occurs; or if called after the connection is closed.

• get

  R get(K key)
        throws GSException

  Returns the content of a Row corresponding to the specified Row key.

  It behaves in the same way as get(Object, boolean) called without requesting a lock for update.

  Throws:

  GSException

  See Also:

  get(Object, boolean)

• get

  R get(K key,
      boolean forUpdate)
        throws GSException

  Returns the content of a Row corresponding to the specified Row key according to the specified option.

  It can be used only if a Column exists which corresponds to the specified Row key.

  If it requests a lock for update in the manual commit mode, it will hold the lock until a relevant transaction completes or a timeout occurs. The update or deletion operation by any other transaction on the locked Row will wait until the transaction completes or a timeout occurs. The lock will be held even if the target Row is deleted.

  In the autocommit mode, it cannot request a lock for update.

  Parameters:

  forUpdate - indicates whether it requests a lock for update.

  Returns:

  A target Row object. null if no target Row exists.

  Throws:

  GSException - if no Column exists which corresponds to the specified Row key.

  GSException - if it requests a lock for update in the autocommit mode.

  GSException - if a timeout occurs during this operation or the transaction, this Container is deleted, its schema is changed or a connection failure occurs; or if called after the connection is closed; or if an unsupported value is specified as key.

  java.lang.ClassCastException - if the specified Row key does not match the type of a Row key used in mapping operation.

  java.lang.NullPointerException - if null is specified as key.

• getBindType

  Container.BindType<K,R,? extends Container<K,R>> getBindType()
                                                               throws GSException

  Returns the type information associated with this object.

  The type information obtained is set to be the same as the Row key type and Row object type specified when the object was configured.

  The type of Container or its subinterface is not necessarily the same as the type specified at the time of configuration; the type obtained may be that of the subinterface. Furthermore, a one-to-one correspondence with the container type represented by ContainerType is not guaranteed.

  Returns:

  Type information associated with this object

  Throws:

  GSException - If invoked after being closed

  Since:

  4.3

• getType

  ContainerType getType()
                        throws GSException

  Get the type of this Container.

  In the current version, no inquiry is sent to the GridDB cluster by this operation as the type is always confirmed at the point the instance is generated.

  Throws:

  GSException - If invoked after being closed

• put

  boolean put(java.util.Collection<R> rowCollection)
              throws GSException

  Based on the specified Row object group, an arbitrary number of Rows will be consolidated to create a new group or updated.

  For each Row in the specified Row object group, a new creation or update operation is carried out just like the case when put(Object) is invoked in accordance with the take-out sequence from the iterator.

  If multiple Rows having the same Row key exist in the specified Row object group, the contents of the rear-most Row having the same Row key will be reflected using the take-out sequence from the iterator of the Row object group as a reference.

  Depending on the Container type and setting, the same restrictions as put(Object) are established for the contents of Rows that can be operated. Refer to definition of the sub-interface for the specific restrictions.

  In the manual commit mode, the target Rows are locked.

  In the auto commit mode, if an exclusion occurs in the midst of processing a Container and its Rows, only the results for some of the Rows in the Container may remain reflected.

  Returns:

  Always false in the current version

  Throws:

  GSException - When an operation violating the restrictions unique to a specific Container type is carried out

  GSException - if a timeout occurs during this operation or the transaction, this Container is deleted, its schema is changed or a connection failure occurs; or if called after the connection is closed; or if an unsupported value is set in the key or the Row object.

  java.lang.ClassCastException - if the specified Row objects does not match the value types of Row objects used in mapping operation, respectively.

  java.lang.NullPointerException - if NULL is specified as rowCollection or its element; As with put(Object, Object), if null is included in a specific part of the row object.

  See Also:

  put(Object)

• put

  boolean put(K key,
            R row)
              throws GSException

  Newly creates or updates a Row, based on the specified Row object and also the Row key specified as needed.

  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 a Row key is specified besides a Row object, the specified Row key is used in preference to the Row key in the Row object.

  If no Column exists which corresponds to the specified Row key, it always creates a new Row. In such a case, specify null as key.

  Restrictions are applied depending on the type of Container and its settings. See the descriptions of subinterfaces for detailed restrictions.

  In the manual commit mode, the target Row is locked.

  Parameters:

  key - A target Row key

  row - A Row object representing the content of a Row to be newly created or updated.

  Returns:

  TRUE if a Row exists which corresponds to the specified Row key.

  Throws:

  GSException - if a Row key is specified although no Column exists which corresponds to the key.

  GSException - if its operation is contrary to the restrictions specific to a particular Container.

  GSException - if a timeout occurs during this operation or the transaction, this Container is deleted, its schema is changed or a connection failure occurs; or if called after the connection is closed; or if an unsupported value is set in the key or the Row object.

  java.lang.ClassCastException - if the specified key or Row object does not completely match the type(s) used in mapping operation.

  java.lang.NullPointerException - if null is specified as row; For objects in row objects corresponding to row fields, if there is a NOT NULL constrain but null is set, it will in include elements of null when array type is selected.

• put

  boolean put(R row)
              throws GSException

  Newly creates or updates a Row, based on the specified Row object only.

  It behaves in the same way as put(Object, Object), except that it uses a Row key in the specified Row object.

  Throws:

  GSException

  See Also:

  put(Object, Object)

• query

  Query<R> query(java.lang.String tql)
                 throws GSException

  Creates a query object to execute the specified TQL statement.

  It cannot be used for a query whose output format does not match the types of Rows in this Container, such as a query containing an aggregation operation in its selection expression. For such a query, query(String, Class) can be used instead.

  When obtaining a set of Rows using Query.fetch(boolean), the option of locking for update can be enabled only for the queries that will not select Rows which do not exist in this Container. For example, it cannot be enabled for a query containing an interpolation operation.

  In the current version, due to an error in the TQL statement, GSException and by specifying null with an argument that cannot specify null, NullPointerException will not be dispatched. If there is an error in the argument, an exception will be thrown when the resulting query is fetched.

  Parameters:

  tql - TQL statement. null cannot be specified

  Throws:

  GSException - It will not be thrown in the current version.

  See Also:

  query(String, Class)

• query

  <S> Query<S> query(java.lang.String tql,
                   java.lang.Class<S> rowType)
                 throws GSException

  Creates a query object to execute the specified TQL statement and return the specified type of result.

  It is used for a query whose output format does not match the types of Rows in this Container, such as an aggregation operation. The following types and null are only available as rowType.

  Row type of Container

  Indicates receiving Row data of the type matching the Rows in this Container, as in query(String).

  AggregationResult

  Indicates receiving the result of executing an aggregation operation.

  QueryAnalysisEntry

  Indicates receiving the result of executing an EXPLAIN or EXPLAIN ANALYZE statement.

  null

  Indicates receiving a proper type of result, depending on the operation.

  No other value can be specified.

  When obtaining a set of Rows using Query.fetch(boolean), the option of locking for update can be enabled only for the queries that will not select Rows which do not exist in this Container. For example, it cannot be enabled for a query containing an interpolation operation.

  In the current version, due to an error in the TQL statement, GSException and by specifying null with an argument that cannot specify null, NullPointerException will not be dispatched. If there is an error in the argument, an exception will be thrown when the resulting query is fetched.

  Parameters:

  tql - TQL statement. null cannot be specified

  rowType - the expected row object type or null

  Throws:

  GSException - if an unsupported type is specified as rowType.

• remove

  boolean remove(K key)
                 throws GSException

  Deletes a Row corresponding to the specified Row key.

  It can be used only if a Column exists which corresponds to the specified Row key. If no corresponding Row exists, nothing is changed.

  Restrictions are applied depending on the type of Container and its settings. See the descriptions of subinterfaces for detailed restrictions.

  In the manual commit mode, the target Row is locked.

  Returns:

  TRUE if a corresponding Row exists.

  Throws:

  GSException - if no Column exists which corresponds to the specified Row key.

  GSException - if its operation is contrary to the restrictions specific to a particular Container.

  GSException - if a timeout occurs during this operation or the transaction, this Container is deleted, its schema is changed or a connection failure occurs; or if called after the connection is closed; or if an unsupported value is specified as key.

  java.lang.ClassCastException - if the specified Row key does not match the type of a Row key used in mapping operation.

  java.lang.NullPointerException - if null is specified.

• setAutoCommit

  void setAutoCommit(boolean enabled)
                     throws GSException

  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 autocommit mode is switched from On to Off, uncommitted updates are committed implicitly. Unless the commit mode is changed, the state of the transaction will not be changed. These behaviors are the same as those of Connection.setAutoCommit(boolean).

  Throws:

  GSException - if a timeout occurs during this operation or the transaction, this Container is deleted or a connection failure occurs, when a commit is requested after a mode change; or if called after the connection is closed.

Constructor Detail

• ContainerInfo

  public ContainerInfo()

  Creates an empty ContainerInfo.

• ContainerInfo

  public ContainerInfo(ContainerInfo containerInfo)

  Duplicates the information about the specified Container.

  Parameters:

  containerInfo - Copied Container information. null cannot be specified.

  Throws:

  java.lang.NullPointerException - when null is specified as argument

  Since:

  1.5

• ContainerInfo

  public ContainerInfo(java.lang.String name,
               ContainerType type,
               java.util.List<ColumnInfo> columnInfoList,
               boolean rowKeyAssigned)

  Limited to those with no composite Row key, creates container information by specifying information on the column layout.

  Parameters:

  name - Container name. Not set when null is specified.

  type - Container type. Not set when null is specified.

  columnInfoList - List of column information. null cannot be specified.

  rowKeyAssigned - if a column is assigned or not to the Row key: true if a single column is assigned, false otherwise

  Throws:

  java.lang.NullPointerException - when null is specified as argument

  Since:

  1.5

• ContainerInfo

  public ContainerInfo(java.lang.String name,
               ContainerType type,
               java.util.List<ColumnInfo> columnInfoList,
               java.util.List<java.lang.Integer> rowKeyColumnList)

  Creates container information by specifying information about column layout, including any Row key configuration.

  Parameters:

  name - Container name. Not set when null is specified.

  type - Container type. Not set when null is specified.

  columnInfoList - List of column information. null cannot be specified.

  rowKeyColumnList - List of column numbers starting from 0 for the columns configuring the Row key. If a list of length 0 or null is specified, it is assumed that there is no Row key.

  Throws:

  java.lang.NullPointerException - when null is specified as argument

  Since:

  4.3

Method Detail

• getColumnCount

  public int getColumnCount()

  Returns the number of Columns of the specified Container.

  Returns:

  A number of Columns, or 0 if Column layout is unspecified.

• getColumnInfo

  public ColumnInfo getColumnInfo(int column)

  Returns the information about the specified Column.

  Parameters:

  column - An index of a Column, from 0 to number of Columns minus one.

  Returns:

  The information of the Column corresponding to the specified index.

  Throws:

  java.lang.IllegalArgumentException - If the specified Column number is out of range.

  See Also:

  RowField.columnNumber()

• getDataAffinity

  public java.lang.String getDataAffinity()

  Returns a data affinity string of the Container.

  Returns:

  A data affinity string, or null as default.

  See Also:

  setDataAffinity(String)

• getIndexInfoList

  public java.util.List<IndexInfo> getIndexInfoList()

  Get a list of index information.

  UnsupportedOperationException may occur if the returned value is changed. Also, the operation on this object does not change the contents of the returned object.

  Returns:

  List of index information.

  Since:

  3.5

• getName

  public java.lang.String getName()

  Returns the name of the specified Container.

  Returns:

  A Container name, or null if unspecified.

• getRowKeyColumnList

  public java.util.List<java.lang.Integer> getRowKeyColumnList()

  Returns the list of columns that configures the Row key.

  UnsupportedOperationException may occur if the returned value is changed. Also, the operation on this object does not change the contents of the returned object.

  Returns:

  List of column numbers starting from 0 for the columns configuring the Row key. A list of length 0 if the corresponding container has no Row key

  Since:

  4.3

• getTimeSeriesProperties

  public TimeSeriesProperties getTimeSeriesProperties()

  Returns the optional properties of TimeSeries.

  If the contents of the returned object is changed after it has been invoked, it is not defined whether the contents of this content will be changed or not. Moreover, it is not defined whether the contents of the returned object will be changed or not by operating this object.

  Returns:

  The optional properties of TimeSeries, or null if undefined.

• getTriggerInfoList

  public java.util.List<TriggerInfo> getTriggerInfoList()

  Returns a list of the trigger information.

  UnsupportedOperationException can occur when the returned value is updated. After objects are returned, updates of this object do not change the returned object.

  Returns:

  A list of the trigger information.

• getType

  public ContainerType getType()

  Returns the Container type of the specified Container.

  Returns:

  A Container type, or null if unspecified.

  See Also:

  ContainerType

• isColumnOrderIgnorable

  public boolean isColumnOrderIgnorable()

  Checks if the order of Columns can be ignored.

  Returns:

  true if yes, otherwise false.

• isRowKeyAssigned

  public boolean isRowKeyAssigned()

  Limited to those with no composite Row key, checks if a Column is assigned as a Row key.

  If this method returns true, the column number corresponding to the Row key is 0.

  Use getRowKeyColumnList() to refer to any Row key configuration.

  Returns:

  true If a Row key is assigned, otherwise false.

  Throws:

  java.lang.IllegalStateException - if a composite Row key has been set

• setColumnInfoList

  public void setColumnInfoList(java.util.List<ColumnInfo> columnInfoList)

  Set information of all Columns all at once.

  The order of the Columns of the Container corresponds to the order of information of the Columns, if its can be ignored.

  It can be undefined, regardless of the existence of a Row key Column.

  Updates of the specified object after this function is specified will not change the object.

  Parameters:

  columnInfoList - List of the information of Columns. For null or an empty list, the setting is cancelled.

  See Also:

  setColumnOrderIgnorable(boolean)

• setColumnOrderIgnorable

  public void setColumnOrderIgnorable(boolean ignorable)

  Sets whether the order of Columns can be ignored.

  Default value cannot be ignored (false).

  Parameters:

  ignorable - If the order of Columns can be ignored

  See Also:

  GridStore.putContainer(String, ContainerInfo, boolean)

• setDataAffinity

  public void setDataAffinity(java.lang.String dataAffinity)

  Sets a string to represent similarity between containers (data affinity). The string is used for optimizing the data allocation.

  A data affinity string is for optimizing the arrangement of Containers among the nodes of the cluster.

  Containers which have the same data affinity may be stored near each other. Therefore the efficiency for the expiration of Rows may be improved by using the same data affinity string for TimeSeries Containers which includes Rows with similar elapsed time periods.

  There are the limitations, allowed characters and maximum length, for the data affinity string. See GridDB Features Reference for the details. All the limitations may not be checked when setting the string. The data affinity string is case-sensitive unless otherwise noted.

  Parameters:

  dataAffinity - A string to represent similarity between containers. If null is specified, the Container will be stored as usual. There are the cases that string against the limitations cannot be specified.

  Throws:

  java.lang.IllegalArgumentException - If the specified string is not proper.

  Since:

  2.1

• setIndexInfoList

  public void setIndexInfoList(java.util.List<IndexInfo> indexInfoList)

  Set a list of index information.

  Even if you change the contents of the specified object after calling, the contents of this object will not change.

  Parameters:

  indexInfoList - List of index information. Not set in the case of null or empty list.

  Since:

  3.5

• setName

  public void setName(java.lang.String name)

  Sets a name of the Container.

  Parameters:

  name - A name of the Container. For null, the setting is cancelled.

• setRowKeyAssigned

  public void setRowKeyAssigned(boolean assigned)

  Sets a Row key Column is assigned or not.

  A Row key is assigned default.

  This function is available regardless of the layout of Columns.

  Parameters:

  assigned - A Row key Column is assigned or not. true for assigned, otherwise false.

• setRowKeyColumnList

  public void setRowKeyColumnList(java.util.List<java.lang.Integer> rowKeyColumnList)

  Sets the list of columns that configures the Row key.

  Updates of the specified object after this function is specified will not change the object.

  Parameters:

  rowKeyColumnList - List of column numbers starting from 0 for the columns configuring the Row key. If a list of length 0 or null is specified, it is assumed that there is no Row key.

  Since:

  4.3

• setTimeSeriesProperties

  public void setTimeSeriesProperties(TimeSeriesProperties props)

  Sets the optional properties of TimeSeries.

  This function is available for any Container type.

  Updates of the specified object after this function is invoked will not change the object.

  Parameters:

  props - The optional properties of TimeSeries. For null, the setting is cancelled.

• setTriggerInfoList

  public void setTriggerInfoList(java.util.List<TriggerInfo> triggerInfoList)

  Sets all information of triggers.

  Parameters:

  triggerInfoList - A list of trigger information. For null, the setting is cancelled.

• setType

  public void setType(ContainerType type)

  Sets a type of the Container.

  Parameters:

  type - A type of the Container. For null, the setting is cancelled.

Enum Constant Detail

• COLLECTION

  public static final ContainerType COLLECTION

  Indicates the target Container is a Collection.

• TIME_SERIES

  public static final ContainerType TIME_SERIES

  Indicates the target Container is a TimeSeries.

Method Detail

• valueOf

  public static ContainerType valueOf(java.lang.String name)

  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

  Parameters:

  name - the name of the enum constant to be returned.

  Returns:

  the enum constant with the specified name

  Throws:

  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

  java.lang.NullPointerException - if the argument is null

• values

  public static ContainerType[] values()

  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

  for (ContainerType c : ContainerType.values())
      System.out.println(c);
  

  Returns:

  an array containing the constants of this enum type, in the order they are declared

Enum Constant Detail

• LIMIT

  public static final FetchOption LIMIT

  Used to set the maximum number of Rows to be fetched.

  If the number of Rows in a result exceeds the maximum, the maximum number of Rows counting from the 0-th in RowSet are fetched. The rest of the Rows in the result cannot be fetched.

  The supported types of values are Integer and Long. Negative values are not available. If the setting is omitted, the limit is not defined.

• PARTIAL_EXECUTION

  public static final FetchOption PARTIAL_EXECUTION

  Used to set the partial execution mode.

  In the partial execution mode, it is trying for the buffer size of the intermediate query processing and the data transfer, etc. to fit inside a fixed size by dividing the target data and getting the query results in each divided range. Therefore the results for some data ranges may not be determined when the RowSet is obtained, and in the middle of getting the results, there are the cases that the query is executed partially for the rest of the ranges.

  In this version, the partial execution mode can be used for queries satisfying all the following conditions. And it can be used in combination with LIMIT option. Even if not satisfying the conditions, the error may not be detected when setting the fetch option.

  • The query must be specified by TQL
  • The SELECT clause must be consisted of only '*' and an ORDER BY clause must not be specified.
  • The target Container must have been set to the auto commit mode at the each partial execution of the query.

  In the partial execution mode, rows that can be fetched at the each partial execution of the query based on the separation level and the status of the corresponding Container transaction are used. However rows that don't exist at the first time of the whole query execution may not be reflected to the results.

  For inhibited operations and behaviors on RowSet in this mode, see the individual definitions.

  The only supported type for this setting is Boolean. The value matching to Boolean.TRUE must be specified to activate this mode. In this version, the partial execution mode is not effective unless setting the mode explicitly.

  Since:

  4.0

Method Detail

• valueOf

  public static FetchOption valueOf(java.lang.String name)

  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

  Parameters:

  name - the name of the enum constant to be returned.

  Returns:

  the enum constant with the specified name

  Throws:

  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

  java.lang.NullPointerException - if the argument is null

• values

  public static FetchOption[] values()

  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

  for (FetchOption c : FetchOption.values())
      System.out.println(c);
  

  Returns:

  an array containing the constants of this enum type, in the order they are declared

Constructor Detail

• GSException

  public GSException()

  Build a non-descriptive exception.

  See Also:

  Exception.Exception()

• GSException

  public GSException(int errorCode,
             java.lang.String description)

  Specify the error number and description, then build an exception.

  Parameters:

  errorCode - Error number

  description - Description or null

  See Also:

  Exception.Exception(String)

• GSException

  public GSException(int errorCode,
             java.lang.String errorName,
             java.lang.String description,
             java.util.Map<java.lang.String,java.lang.String> parameters,
             java.lang.Throwable cause)

  Specify the error number, error name, description, map of parameters, and cause, then build an exception.

  Parameters:

  errorCode - Error number

  errorName - Error name or null

  description - Description or null

  parameters - Map of paramaters or null

  cause - Cause or null

  See Also:

  Exception.Exception(String, Throwable)

• GSException

  public GSException(int errorCode,
             java.lang.String errorName,
             java.lang.String description,
             java.lang.Throwable cause)

  Specify the error number, error name, description, and cause, then build an exception.

  Parameters:

  errorCode - Error number

  errorName - Error name or null

  description - Description or null

  cause - Cause or null

  See Also:

  Exception.Exception(String, Throwable)

• GSException

  public GSException(int errorCode,
             java.lang.String description,
             java.lang.Throwable cause)

  Specify the error number, description and cause, then build an exception.

  Parameters:

  errorCode - Error number

  description - Description or null

  cause - Cause or null

  See Also:

  Exception.Exception(String, Throwable)

• GSException

  public GSException(int errorCode,
             java.lang.Throwable cause)

  Specify the error number and description, then build an exception.

  Parameters:

  errorCode - Error number

  cause - Cause or null

  See Also:

  Exception.Exception(Throwable)

• GSException

  public GSException(java.lang.String message)

  Specify the description, then build an exception.

  Parameters:

  message - Description or null

  See Also:

  Exception.Exception(String)

• GSException

  public GSException(java.lang.String message,
             java.lang.Throwable cause)

  Specify the description and cause, then build an exception.

  Parameters:

  message - Description or null

  cause - Cause or null

  See Also:

  Exception.Exception(String, Throwable)

• GSException

  public GSException(java.lang.Throwable cause)

  Specify the error, then build an exception.

  Parameters:

  cause - Cause or null

  See Also:

  Exception.Exception(Throwable)

Method Detail

• getErrorCode

  public int getErrorCode()

  Returns an error number.

  It returns 0 if no corresponding number is found.

• getMessage

  public java.lang.String getMessage()

  Overrides:

  getMessage in class java.lang.Throwable

• getParameters

  public java.util.Map<java.lang.String,java.lang.String> getParameters()

  Returns a map of parameters related to the error.

  It is used to extract particular information about the error. Returned map is a set which each entry consists of a parameter name and a parameter value. For the parameters included in this map, see the definition of interfaces which may output this exception or the definition of related interfaces.

  The information in the map is also included in the message string returned by getMessage() in principle. But by a fixed parsing rule, it may not be able to extract the particular information from this message. Even if the intended information can be extracted from a context in a version, for other conditions, unintended information may be acquired or nothing may be acquired. By using this map, a part of information specified in the definition of the interfaces can be acquired without parsing.

  When recording only the content of the returned map and not recording other exception information such as the message text, it may become difficult to identify the reason for the error.

Constructor Detail

• GSTimeoutException

  public GSTimeoutException()

  Build a non-descriptive exception.

  See Also:

  GSException.GSException()

• GSTimeoutException

  public GSTimeoutException(int errorCode,
                    java.lang.String description)

  Specify the error number and description, then build an exception.

  Parameters:

  errorCode - Error number

  description - Description or null

  See Also:

  GSException.GSException(int, String)

• GSTimeoutException

  public GSTimeoutException(int errorCode,
                    java.lang.String errorName,
                    java.lang.String description,
                    java.util.Map<java.lang.String,java.lang.String> parameters,
                    java.lang.Throwable cause)

  Specify the error number, error name, description, map of parameters, and cause, then build an exception.

  Parameters:

  errorCode - Error number

  errorName - Error name or null

  description - Description or null

  parameters - Map of paramaters or null

  cause - Cause or null

  See Also:

  GSException.GSException(int, String, String, Map, Throwable)

• GSTimeoutException

  public GSTimeoutException(int errorCode,
                    java.lang.String errorName,
                    java.lang.String description,
                    java.lang.Throwable cause)

  Specify the error number, error name, description, and cause, then build an exception.

  Parameters:

  errorCode - Error number

  errorName - Error name or null

  description - Description or null

  cause - Cause or null

  See Also:

  GSException.GSException(int, String, String, Throwable)

• GSTimeoutException

  public GSTimeoutException(int errorCode,
                    java.lang.String description,
                    java.lang.Throwable cause)

  Specify the error number, description and cause, then build an exception.

  Parameters:

  errorCode - Error number

  description - Description or null

  cause - Cause or null

  See Also:

  GSException.GSException(int, String, Throwable)

• GSTimeoutException

  public GSTimeoutException(int errorCode,
                    java.lang.Throwable cause)

  Specify the error number and description, then build an exception.

  Parameters:

  errorCode - Error number

  cause - Cause or null

  See Also:

  GSException.GSException(int, Throwable)

• GSTimeoutException

  public GSTimeoutException(java.lang.String message)

  Specify the description, then build an exception.

  Parameters:

  message - Description or null

  See Also:

  GSException.GSException(String)

• GSTimeoutException

  public GSTimeoutException(java.lang.String message,
                    java.lang.Throwable cause)

  Specify the description and cause, then build an exception.

  Parameters:

  message - Description or null

  cause - Cause or null

  See Also:

  GSException.GSException(String, Throwable)

• GSTimeoutException

  public GSTimeoutException(java.lang.Throwable cause)

  Specify the error, then build an exception.

  Parameters:

  cause - Cause or null

  See Also:

  GSException.GSException(Throwable)

Enum Constant Detail

• BLOB

  public static final GSType BLOB

• BOOL

  public static final GSType BOOL

• BOOL_ARRAY

  public static final GSType BOOL_ARRAY

• BYTE

  public static final GSType BYTE

• BYTE_ARRAY

  public static final GSType BYTE_ARRAY

• DOUBLE

  public static final GSType DOUBLE

• DOUBLE_ARRAY

  public static final GSType DOUBLE_ARRAY

• FLOAT

  public static final GSType FLOAT

• FLOAT_ARRAY

  public static final GSType FLOAT_ARRAY

• GEOMETRY

  public static final GSType GEOMETRY

• INTEGER

  public static final GSType INTEGER

• INTEGER_ARRAY

  public static final GSType INTEGER_ARRAY

• LONG

  public static final GSType LONG

• LONG_ARRAY

  public static final GSType LONG_ARRAY

• SHORT

  public static final GSType SHORT

• SHORT_ARRAY

  public static final GSType SHORT_ARRAY

• STRING

  public static final GSType STRING

• STRING_ARRAY

  public static final GSType STRING_ARRAY

• TIMESTAMP

  public static final GSType TIMESTAMP

• TIMESTAMP_ARRAY

  public static final GSType TIMESTAMP_ARRAY

Method Detail

• valueOf

  public static GSType valueOf(java.lang.String name)

  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

  Parameters:

  name - the name of the enum constant to be returned.

  Returns:

  the enum constant with the specified name

  Throws:

  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

  java.lang.NullPointerException - if the argument is null

• values

  public static GSType[] values()

  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

  for (GSType c : GSType.values())
      System.out.println(c);
  

  Returns:

  an array containing the constants of this enum type, in the order they are declared

Method Detail

• equals

  public boolean equals(java.lang.Object obj)

  Indicates whether some other object is "equal to" this one.

  Objects generated by valueOf(String) and have no notation difference except inconsistent spelling such as blank character as a delimiter or the default SRID values are considered to be equivalent even if WKT representation of the source is not equivalent to each other as a string. For example, objects generated with the following three WKT representation are considered to be equivalent.

   POLYGON((0 0,10 0,10 10,0 10,0 0))
   POLYGON( (0 0,10 0,10 10,0 10,0 0) )
   POLYGON((0 0,10 0,10 10,0 10,0 0);-1)

  On the other hand, objects which have no equivalent WKT representation as a string because of the difference in the start/end position to the closed line that make up the area are considered not to be equivalent even if they indicate to the same space region. For example, objects generated with the following two WKT representation are considered not to be equivalent.

   POLYGON((0 0,10 0,10 10,0 10,0 0))
   POLYGON((0 10,0 0,10 0,10 10,0 10))

  This method maintain the general contract for the Object.hashCode() method, which states that equal objects must have equal hash codes.

  Overrides:

  equals in class java.lang.Object

  Parameters:

  obj - The reference object to be compared

  Returns:

  true if this object is equal to obj, otherwise false

  See Also:

  hashCode()

• hashCode

  public int hashCode()

  Returns the hash code of this object.

  This method maintain the general contract for the Object.hashCode() method, which states that equal objects must have equal hash codes.

  Overrides:

  hashCode in class java.lang.Object

  Returns:

  Hash code of this object

  See Also:

  equals(Object)

• toString

  public java.lang.String toString()

  Returns the string representation (WKT representation) in WKT (Well-Known Text) format.

  Returned string may not be equivalent to the specified WKT representation when generated by valueOf(String), if there are inconsistent spelling such as blank character as a delimiter or the default SRID values.

  Overrides:

  toString in class java.lang.Object

• valueOf

  public static Geometry valueOf(java.lang.String value)
                          throws java.lang.IllegalArgumentException

  Creates the Geometry from the string representation (WKT representation) to geometry data in WKT (Well-Known Text) format.

  Supported WKT representation is the same as the representation range to be handled by ST_GeomFromText function in TQL. However, the geometry structure QUADRATICSURFACE can only be used as search condition and not to be stored in the container.

  Parameters:

  value - WKT representation to be created. null cannot be specified

  Returns:

  Instance of Geometry created by WKT representation

  Throws:

  java.lang.IllegalArgumentException - If the specified string does not match to the WKT format

  java.lang.IllegalArgumentException - when null is specified as argument

Enum Constant Detail

• INTERSECT

  public static final GeometryOperator INTERSECT

  Represents that each spatial ranges or their bounding volume are intersected.

  Represents that each MBBs (Minimum Bounding Box) or MBB and quadric surface are intersected. The conditions for determination of the intersections are the same as ST_MBRIntersects or ST_QSFMBRIntersects in TQL.

Method Detail

• valueOf

  public static GeometryOperator valueOf(java.lang.String name)

  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

  Parameters:

  name - the name of the enum constant to be returned.

  Returns:

  the enum constant with the specified name

  Throws:

  java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

  java.lang.NullPointerException - if the argument is null

• values

  public static GeometryOperator[] values()

  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

  for (GeometryOperator c : GeometryOperator.values())
      System.out.println(c);
  

  Returns:

  an array containing the constants of this enum type, in the order they are declared

Method Detail

• close

  void close()
             throws GSException

  Disconnects with GridDB and releases related resources as necessary.

  Even if GSException is thrown, the connection and local resources are released properly. However, the transaction state etc. might remain in GridDB. If the connection is already closed, this method will not work effectively.

  Specified by:

  close in interface java.lang.AutoCloseable

  Specified by:

  close in interface java.io.Closeable

  Throws:

  GSException - if a connection failure occurs

• createRow

  Row createRow(ContainerInfo info)
                throws GSException

  Creates a new Row by specifying ContainerInfo.

  Include the ColumnInfo list and Row key configuration so as to conform to the restrictions stipulated in Container. Specify the column layout in ContainerInfo.

  In addition, by including the Container type in ContainerInfo, it can be verified whether the restrictions unique to a specific Container type are conformed to or not. However, the Container type will not be included even if a Row.getSchema() is invoked against the created Row.

  Each field will be set to the initial value which is based on ColumnInfo of each column in the specified ContainerInfo. The initial value corresponding to the return value of ColumnInfo.getDefaultValueNull() is selected by the following way.

  Return value of ColumnInfo.getDefaultValueNull()	Initial value
  true	NULL. However a row which violates constraints can not be created.
  false	The empty value. See the definition of Container.
  null	In the current version, same as false.

  An empty value defined in Container is set as the initial value for each field of the created Row.

  The operation on the created Row also does not affect whether this GridStore object is closed or not.

  Parameters:

  info - Container information including the column layout. Other contents are ignored

  Returns:

  Created Row

  Throws:

  GSException - If the Container type or restrictions of the column layout are not conformed to

  GSException - If invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument

  See Also:

  Container

• createRowKey

  Row.Key createRowKey(ContainerInfo info)
                       throws GSException

  Creates a new Row.Key by specifying ContainerInfo.

  Information about columns other than the Row key is ignored. Otherwise, it behaves the same as createRow(ContainerInfo).

  Parameters:

  info - Container information including the column layout. Other contents are ignored

  Returns:

  Created Row.Key

  Throws:

  GSException - If container information without Row key is specified

  GSException - If the Container type or restrictions of the column layout are not conformed to

  GSException - If invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument

  Since:

  4.3

• dropCollection

  void dropCollection(java.lang.String name)
                      throws GSException

  Deletes a Collection with the specified name.

  Deletion handling, transaction handling, and the immediate state after deletion request is completed are the same as those found in dropContainer(String)

  Parameters:

  name - Name of Collection subject to processing

  Throws:

  GSException - if the Container type is unmatched.

  GSException - if a timeout occurs during this operation or a connection failure occurs; or if called after the connection is closed.

  java.lang.NullPointerException - if a null parameter is specified.

• dropContainer

  void dropContainer(java.lang.String name)
                     throws GSException

  Delete a Container having the specified name

  Nothing is changed if the Container has already been deleted.

  If a transaction under execution exists in a Container subject to processing, the system will wait for these to be completed before deleting the data.

  Immediately after the container deletion request is completed, the memory and storage area used for the index or row of the container may not be reused immediately. In addition, when delete processing is run on the cluster, increase in load may occur for sometime.

  Parameters:

  name - Name of a Container subject to processing

  Throws:

  GSException - If this process times out, a connection failure were to occur, or if it is invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument

  See Also:

  dropCollection(String), dropTimeSeries(String)

• dropTimeSeries

  void dropTimeSeries(java.lang.String name)
                      throws GSException

  Deletes a TimeSeries with the specified name.

  Deletion handling, transaction handling, and the immediate state after deletion request is completed are the same as those found in dropContainer(String)

  Parameters:

  name - Name of TimeSeries subject to processing

  Throws:

  GSException - if the Container type is unmatched.

  GSException - if a timeout occurs during this operation or a connection failure occurs; or if called after the connection is closed.

  java.lang.NullPointerException - if a null parameter is specified.

• fetchAll

  void fetchAll(java.util.List<? extends Query<?>> queryList)
                throws GSException

  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 list, perform a similar query execution and fetch as when Query.fetch() is performed individually and set the RowSet in the results. Use Query.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 this GridStore object, can be included in a specified list. Like a Query.fetch(), the RowSet formed last and held by each Query will be closed. If the same instance is included multiple times in a list, 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 GridDB Features Reference for the upper limit size.

  The thrown GSException may contain container parameter. For the details of the parameters related the error, see the definition of GridStore.

  Parameters:

  queryList - List of Query targeted

  Throws:

  GSException - If a Query other than a Query obtained via this GridStore object is included

  GSException - If the system tries to execute a query containing a wrong parameter, syntax or command. For example, when a column type that is not compatible with the argument of the function is specified in the TQL. Refer to the various definitions of the function to create this query for the specific restrictions

  GSException - If the execution results do not conform to the expected type of each component of the RowSet, when a TQL is executed.

  GSException - If this process or related transaction times out, if the corresponding Container is deleted or the schema is changed, if a connection failure occurs, or if the corresponding Container is invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument queryList, or if null is included as a component the argument queryList

  java.lang.NullPointerException - If a non-permitted null is included in the parameter given when creating this query. To be executed in GridDB The evaluation results of the TQL text will not be sent out

  See Also:

  Query.fetch()

• getCollection

  <K> Collection<K,Row> getCollection(java.lang.String name)
                                  throws GSException

  Get a Collection object whose Rows can be processed using a Row.

  Except for points where the expected Container type is limited to ContainerType.COLLECTION and the returned type is Collection, the behavior will be the same as getContainer(String).

  Returns:

  Corresponding Collection if a Collection exists and null if not.

  Throws:

  GSException - If a TimeSeries with the same name exists

  GSException - If this process times out, a connection failure were to occur, or if it is invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument

  See Also:

  getContainer(String)

• getCollection

  <K,R> Collection<K,R> getCollection(java.lang.String name,
                                    java.lang.Class<R> rowType)
                                throws GSException

  Return a Collection object to manipulate a Collection with the specified name.

  For the correspondence between a specified type and a Column layout, see the description of Container.

  Parameters:

  name - Name of a Collection subject to processing

  rowType - Type of Row object corresponding to the column layout of the Collection subject to processing

  Returns:

  A Collection object if a Collection with the specified name exist; or null if not.

  Throws:

  GSException - if a TimeSeries with the same name exists.

  GSException - if the specified type and the existing Column layout conflict each other.

  GSException - if the specified type is not proper as a type of a Row object. For more information, see the description of Container.

  GSException - if a timeout occurs during this operation or a connection failure occurs; or if called after the connection is closed.

  java.lang.NullPointerException - if a null parameter(s) is specified.

• getContainer

  <K> Container<K,Row> getContainer(java.lang.String name)
                                throws GSException

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

  Excluding the next point, the behavior will be the same as getCollection(String, Class) or getTimeSeries(String, Class).

  • Return a Container object based on the existing Container type and column layout
  • No error accompanying these non-conformances will occur as the Container type and column layout are not specified
  • The Row object type of the Container returned will always be Row

  Arguments name with the same respective name are used in the same way as well.

  Parameters:

  name - Name of a Container subject to processing

  Returns:

  Corresponding Container if a Container exists and null if not. If a Container exists and the type is ContainerType.COLLECTION, the instance created will be a Collection instance. If the type is ContainerType.TIME_SERIES, the instance created will be a TimeSeries instance.

  Throws:

  GSException - If this process times out, a connection failure were to occur, or if it is invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument

  See Also:

  getCollection(String, Class), getTimeSeries(String, Class)

• getContainer

  <K,R,C extends Container<K,R>> C getContainer(java.lang.String name,
                                              Container.BindType<K,R,C> bindType)
                                   throws GSException

  Returns a Container object by specifying Container.BindType.

  The behavior is the same as one of the following methods, depending on the specified bindType:

  • getContainer(String)
  • getCollection(String, Class)
  • getTimeSeries(String, Class)

  Parameters:

  name - Name of a Container subject to processing

  bindType - Type information associated with the container subject to processing

  Returns:

  An instance of the type of the corresponding Container or its subinterfaces

  Throws:

  GSException - if the contents of the name and bindType parameters do not conform to the rules

  GSException - If the specified type is not suitable as the Row object type. Refer to the definition of Container for details.

  GSException - If this process times out, a connection failure were to occur, or if it is invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument bindType

  Since:

  4.3

• getContainerInfo

  ContainerInfo getContainerInfo(java.lang.String name)
                                 throws GSException

  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.

  The column sequence is set to Do Not Ignore. This setting can be verified through ContainerInfo.isColumnOrderIgnorable().

  In the current version, whether to use of NULL for the initial value is not set. Note that it may be set in the future version. This information can be acquired through ColumnInfo.getDefaultValueNull() on each column.

  Parameters:

  name - the target Container name

  Returns:

  Container Info of the specific Container.

  Throws:

  GSException - if a timeout occurs during this operation or a connection failure occurs; or if called after the connection is closed.

  java.lang.NullPointerException - if null is specified as the parameter.

• getPartitionController

  PartitionController getPartitionController()
                                             throws GSException

  Get PartitionController on the corresponding GridDB cluster.

  Use is no longer possible once this GridStore is closed.

  Returns:

  PartitionController on the corresponding GridDB cluster

  Throws:

  GSException - If invoked after being closed

  See Also:

  PartitionController

• getTimeSeries

  TimeSeries<Row> getTimeSeries(java.lang.String name)
                                throws GSException

  Get a TimeSeries object whose Rows can be processed using a Row.

  Except for points where the expected Container type is limited to ContainerType.TIME_SERIES and the returned type is TimeSeries, the behavior will be the same as getTimeSeries(String).

  Returns:

  Corresponding TimeSeries if a TimeSeries exists and null if not.

  Throws:

  GSException - If a Collection with the same name exists

  GSException - If this process times out, a connection failure were to occur, or if it is invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument

  See Also:

  getContainer(String)

• getTimeSeries

  <R> TimeSeries<R> getTimeSeries(java.lang.String name,
                                java.lang.Class<R> rowType)
                              throws GSException

  Returns a TimeSeries object to manipulate a TimeSeries with the specified name.

  For the correspondence between a specified type and a Column layout, see the description of Container.

  Parameters:

  name - Name of TimeSeries subject to processing

  rowType - Type of Row object corresponding to the column layout of the TimeSeries subject to processing

  Returns:

  A TimeSeries object if a TimeSeries with the specified name exists; or null if not.

  Throws:

  GSException - if a Collection with the same name exists.

  GSException - if the specified type and the existing Column layout conflict each other.

  GSException - if the specified type is not proper as a type of a Row object. For more information, see the description of Container.

  GSException - if a timeout occurs during this operation or a connection failure occurs; or if called after the connection is closed.

  java.lang.NullPointerException - if a null parameter(s) is specified.

• multiGet

  java.util.Map<java.lang.String,java.util.List<Row>> multiGet(java.util.Map<java.lang.String,? extends RowKeyPredicate<?>> containerPredicateMap)
                                                               throws GSException

  Get an arbitrary number and range of Rows of a Container based on the specified conditions, with the request unit enlarged as much as possible.

  Get the Row contents in accordance with the conditions included in the specified map, similar to invoking Container.get(Object) 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 map is composed of an arbitrary number of 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. The Container cannot include null as a key or value of the map.

  A returned map is composed of entries that adopt the Container name as its key and list of Row objects as its value. And only the real Container names at the request included in a specified map as acquisition conditions are included in a returned map. If multiple entries in which Container names with different notations in uppercase and lowercase letters that specify the same Container are set are included in a specified map, a single entry consolidating these is stored in the returned map. If multiple Row objects are included in the same list, the stored sequence follows the Container type and the definition of the sub-interface of the corresponding Container. If not a single Row corresponding to the specified Container exists, the list of corresponding Row objects is blank.

  When a returned map or list included in a map is updated, whether an exception will occur or not when UnsupportedOperationException, etc. is executed is still not defined.

  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(Object, boolean) or Query.fetch(boolean), 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 GridDB Features Reference for the upper limit size.

  The thrown GSException may contain container parameter. For the details of the parameters related the error, see the definition of GridStore.

  Parameters:

  containerPredicateMap - Map made up of targeted Container names and conditions

  Returns:

  Map that maintains Row groups conforming to the conditions by Container

  Throws:

  GSException - If acquisition conditions concerning a specified Container that cannot be evaluated are specified

  GSException - If this process or transaction times out, a connection failure were to occur, or if it is invoked after being closed

  java.lang.NullPointerException - If null is specified as an argument containerRowsPredicate, if null is included as a key or value of this map

  See Also:

  Container.get(Object), Query.fetch(), RowKeyPredicate

• multiPut

  void multiPut(java.util.Map<java.lang.String,java.util.List<Row>> containerRowsMap)
                throws GSException

  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 map, a new creation or update operation is carried out just like the case when Container.put(Object) 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 map is composed of an arbitrary number of entries that adopt the Container name as its key and list 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. The Container cannot include null as a key or value of the map.

  An arbitrary number of Row with the same column layout as the subject Container can be included in each list of Row objects. In the current version, all the column sequences must also be the same. The Container cannot include null as a component of the list.

  Depending on the Container type and setting, the same restrictions as Container.put(Object) are established for the contents of Rows that can be operated. Refer to the sub-interface definition of Container for the specific restrictions.

  If there are multiple Row objects having the same Row key targeting the same Container in the designated map, the contents of the rear-most Row object having a Row key with the same value will be reflected using the take-out sequence from the iterator of the map entry group as a reference if it is between different lists, or the component sequence of the list as a reference if it is within the same list.

  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 exclusion 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.

  The thrown GSException may contain container parameter. For the details of the parameters related the error, see the definition of GridStore.

  Parameters:

  containerRowsMap - A map made up of a list of Row objects and target Container names

  Throws:

  GSException - If the target Container does not exist, or if the column layouts of the target Container and Row object do not match

  GSException - When an operation violating the restrictions unique to a specific Container type is carried out

  GSException - If this process or transaction times out, a connection failure were to occur, or if it is invoked after being closed, or if a value outside the supported range is included in the Row object

  java.lang.NullPointerException - If null is specified as an argument containerRowsMap, if null is included as a key or value of this map, or if null is included as a component of the list constituting the map

  See Also:

  Container.put(Object)

• putCollection

  <K,R> Collection<K,R> putCollection(java.lang.String name,
                                    java.lang.Class<R> rowType)
                                throws GSException

  Newly creates or updates a Collection.

  If a Container with the specified name does not exist, it newly creates a Collection based on the Column layout defined by the specified class. If a Container with the specified name already exists and its whole Column layout matches the specified type, it behaves in the same way as getCollection(String, Class), except that it waits for active transactions to complete.

  For the correspondence between a specified type and a Column layout, see the description of Container

  If a Collection with the specified name exists and if a transaction(s) is active in the Collection, it does the operation after waiting for the transaction(s) to complete.

  Parameters:

  name - Name of a Collection subject to processing

  rowType - Type of Row object corresponding to the column layout of the Collection subject to processing

  Returns:

  A Collection object created or updated

  Throws:

  GSException - if a Collection with the specified name exists; or if the Column layout and additional settings conflict with the specified type with regard to the existing TimeSeries with the specified name.

  GSException - if a timeout occurs during this operation or a connection failure occurs; or if called after the connection is closed.

  java.lang.NullPointerException - a null parameter(s) is specified.

• putCollection

  <K,R> Collection<K,R> putCollection(java.lang.String name,
                                    java.lang.Class<R> rowType,
                                    boolean modifiable)
                                throws GSException

  Newly creates or updates a Collection with the specified option.

  If a Container with the specified name does not exist, it newly creates a Collection based on the Column layout defined by the specified class. If a Collection with the specified name already exists and its whole Column layout matches the specified type, it behaves in the same way as getCollection(String, Class), except that it waits for active transactions to complete.

  If modifiable is true and a Collection with the specified name exists, it changes its layout as necessary. When changing the layout, it leaves unchanged the existing Columns with the same name and type as defined by the specified class. If a Column name defined by the class is not found in the existing Collection, it creates a Column with the name; and it deletes other Columns in the existing Collection as well as their data. It fails if a Column with the same name but of a different type exists. It is not possible to create or delete a Column corresponding to a Row key.

  If a trigger is set in a Container, and if a column whose trigger is subject to notification is deleted due to a change in the column layout, the column will be deleted from the list of triggers subject to notification.

  The values of Columns to be newly created are initialized with an empty value defined in Container as an initial value.

  For the correspondence between a specified type and a Column layout, see the description of Container

  If a Collection with the specified name exists and if a transaction(s) is active in the Collection, it does the operation after waiting for the transaction(s) to complete.

  When creating a Collection with Row key, an index of default type of the Row key which is defined by Container.createIndex(String) is created. The index is removable.

  In the current version, when conditions such as the size of a container are met, from the beginning to the end of changing the column layout, it is sometimes possible to refer to the container information for the container to be processed and reference the row without updating lock. There are cases where other operations are made to wait as defined in Container. If another operation is performed during column layout change, the prior layout will be used.

  Parameters:

  name - Name of a Collection subject to processing

  rowType - Type of Row object corresponding to the column layout of the Collection subject to processing

  modifiable - Indicates whether the column layout of the existing Collection can be changed or not

  Returns:

  A Collection object created or updated

  Throws:

  GSException - if a TimeSeries with the same name exists; or if modifiable is false and the Column layout of the existing Collection with the specified name conflicts with the requested layout; or if modifiable is true and it attempted to change the unchangeable items in the existing Collection with the specified name.

  GSException - if the specified type is not proper as a type of a Row object. For more information, see the description of Container.

  GSException - if a timeout occurs during this operation or a connection failure occurs; or if called after the connection is closed.

  java.lang.NullPointerException - if a null parameter(s) is specified.

• putCollection

  <K> Collection<K,Row> putCollection(java.lang.String name,
                                    ContainerInfo info,
                                    boolean modifiable)
                                  throws GSException

  Creates a new Collection or updates a Collection by specifying ContainerInfo.

  Except for points where the Container type is limited to ContainerType.COLLECTION and the returned type is Collection, the behavior will be the same as putContainer(String, ContainerInfo, boolean).

  Parameters:

  name - Name of Collection subject to processing

  info - Collection information subject to processing Specify either null or ContainerType.COLLECTION in the Container type

  modifiable - To permit a change in the column layout of an existing Collection or not

  Returns:

  Corresponding Collection.

  Throws:

  GSException - If specifications other than the Container type do not conform to the rules of putContainer(String, ContainerInfo, boolean). If the specifications do not conform to the restrictions related to the Container type as well

  GSException - If this process times out, a connection failure were to occur, or if it is invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument info

  See Also:

  putContainer(String, ContainerInfo, boolean)

• putContainer

  <K,R> Container<K,R> putContainer(java.lang.String name,
                                  java.lang.Class<R> rowType,
                                  ContainerInfo info,
                                  boolean modifiable)
                              throws GSException

  Creates a new Container or updates a Container by specifying the Row object type and ContainerInfo.

  Mainly used when specifying the type of Row object and creating a new Container with additional settings.

  Same as putContainer(String, ContainerInfo, boolean) if points for which the ignore setting of the column layout and column sequence cannot be specified are excluded.

  Parameters:

  name - Name of a Container subject to processing

  rowType - Type of Row object corresponding to the column layout of the Collection subject to processing

  info - Information of a Container subject to processing. Ignored if null is specified

  modifiable - To permit a change in the column layout of existing Container data or not

  Returns:

  Corresponding Container. If ContainerType.COLLECTION is specified as the Container type, the instance created will be a Collection instance. If ContainerType.TIME_SERIES is specified, the instance created will be a TimeSeries instance.

  Throws:

  GSException - If the contents of the arguments name and info do not conform to the rules. If the contents also do not conform to the rules of the new Container creation and update method for the specified Container type

  GSException - If the specified type is not suitable as the Row object type. Refer to the definition of Container for details.

  GSException - If this process times out, a connection failure were to occur, or if it is invoked after being closed

  java.lang.NullPointerException - If null is specified as an argument rowType

  See Also:

  putContainer(String, ContainerInfo, boolean), putCollection(String, Class, boolean), putTimeSeries(String, Class, TimeSeriesProperties, boolean)

• putContainer

  <K,R,C extends Container<K,R>> C putContainer(java.lang.String name,
                                              Container.BindType<K,R,C> bindType)
                                   throws GSException

  Creates a new container or updates a container by specifying Container.BindType.

  The behavior is the same as when putContainer(String, Container.BindType, ContainerInfo, boolean) is called without specifying the container information and not allowing the column layout to be updated.

  Parameters:

  name - Name of a Container subject to processing

  bindType - Type information associated with the container subject to processing

  Returns:

  An instance of the type of the corresponding Container or its subinterfaces

  Throws:

  GSException - If the contents of the name and bindType parameters do not conform to the rules. If the contents also do not conform to the rules of the new Container creation and update method for the specified Container type

  GSException - If the specified type is not suitable as the Row object type. Refer to the definition of Container for details.

  GSException - If this process times out, a connection failure were to occur, or if it is invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument bindType

  Since:

  4.3

• putContainer

  <K,R,C extends Container<K,R>> C putContainer(java.lang.String name,
                                              Container.BindType<K,R,C> bindType,
                                              ContainerInfo info,
                                              boolean modifiable)
                                   throws GSException

  Creates a new container or updates a container by specifying Container.BindType and ContainerInfo.

  The behavior is the same as one of the following methods, depending on the specified bindType:

  • putContainer(String, ContainerInfo, boolean)
  • putContainer(String, Class, ContainerInfo, boolean)

  Parameters:

  name - Name of a Container subject to processing

  bindType - Type information associated with the container subject to processing

  info - Information of a Container subject to processing. Ignored if null is specified

  modifiable - To permit a change in the column layout of existing Container data or not

  Returns:

  An instance of the type of the corresponding Container or its subinterfaces

  Throws:

  GSException - If the contents of the name, bindType, and info arguments do not conform to the rules. If the contents also do not conform to the rules of the new Container creation and update method for the specified Container type

  GSException - If the specified type is not suitable as the Row object type. Refer to the definition of Container for details.

  GSException - If this process times out, a connection failure were to occur, or if it is invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument bindType

  Since:

  4.3

• putContainer

  <K> Container<K,Row> putContainer(java.lang.String name,
                                  ContainerInfo info,
                                  boolean modifiable)
                                throws GSException

  Creates a new Container or updates a Container by specifying ContainerInfo.

  Excluding the next point, the behavior will be the same as putCollection(String, Class, boolean) or putTimeSeries(String, Class, TimeSeriesProperties, boolean).

  • Use ContainerInfo to specify the Container type, column layout, as well as the TimeSeries composition option where necessary
  • The Row object type of the Container returned will always be Row

  Arguments modifiable with the same respective name are used in the same way as well.

  A list of the methods to specify Container-related information is given below.

  item	argument	description
  Container name	name or info	Specify a value that is not null in at least one of the arguments. A different value must be specified when specifying both sides.
  Container type	info	Specify a value that is not null. If ContainerType.COLLECTION is specified, the behavior will be the same as putCollection(String, Class, boolean). If ContainerType.TIME_SERIES is specified, the behavior will be the same as putTimeSeries(String, Class, TimeSeriesProperties, boolean).
  Column layout	info	Set the ColumnInfo list and Row key configuration so as to conform to the restrictions stipulated in Container. However, in the current version, it is not allowed that the list includes one or more ColumnInfo which returns a value except for null through ColumnInfo.getDefaultValueNull().
  Ignore column sequence	info	If ignored, no verification of the conformance with the column sequence of existing Containers with the same name will be carried out.
  TimeSeries composition option	info	A value that is not null can be specified only if the Container type is ContainerType.TIME_SERIES.
  Index setting	info	Ignored in the current version. In future versions, if settings that do not conform to the rules of Container.createIndex(String, IndexType) are included, an exception may be sent out.
  Trigger setting	info	Ignored in the current version. In future versions, if settings that do not conform to the rules of Container.createTrigger(TriggerInfo) are included, an exception may be sent out.
  Container similarity	info	The specified contents will be reflected if a setting other than null is specified and newly created. The settings of an existing Container cannot be changed. The settings are ignored if null is specified.

  Parameters:

  name - Name of a Container subject to processing

  info - Information of a Container subject to processing

  modifiable - To permit a change in the column layout of existing Container data or not

  Returns:

  Corresponding Container. If ContainerType.COLLECTION is specified as the Container type, the instance created will be a Collection instance. If ContainerType.TIME_SERIES is specified, the instance created will be a TimeSeries instance.

  Throws:

  GSException - If the contents of the arguments name and info do not conform to the rules. If the contents also do not conform to the rules of the new Container creation and update method for the specified Container type

  GSException - If this process times out, a connection failure were to occur, or if it is invoked after being closed

  java.lang.NullPointerException - If null is specified in the argument info

  See Also:

  putCollection(String, Class, boolean), putTimeSeries(String, Class, TimeSeriesProperties, boolean), Container