Class

Method

Description

Input example

Output example

AggregationResult

object get(Type $type) ※object: integer or float or datetime

Returns the aggregation result

Container

void createIndex(string $columnName, IndexType $indexType=DEFAULT_TYPE)

Creates a specified type of index on the specified Column

void dropIndex(string $columnName, IndexType $indexType=DEFAULT_TYPE)

Removes the specified type of index among indexes on the specified Column

void flush()

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

boolean put(array[object] $row)

Newly creates or update a Row

$row = [1, "val"]

Query query(string $query)

Creates a query to execute the specified TQL statement

ContainerType type

Read-only attribute

void abort()

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

void commit()

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

void setAutoCommit(boolean $enabled)

Change the setting of the commit mode

array[object] get(object $key)

Returns the content of a Row corresponding to Row key

[1, "val"]

boolean remove(object $key)

Deletes a Row corresponding to Row key

GSException

boolean isTimeout

Read-only attribute

int getErrorStackSize()

Returns the stack size of last error information related to specified resource

int getErrorCode(int $stackIndex)

Returns the error code of last error related to specified resource

string getMessage(int $stackIndex)

Returns the message of last error related to specified resource

string getLocation(int $stackIndex)

Returns the error location of the internal module to the message of last error related to specified resource

PartitionController

int partitionCount

Read-only attribute

int getContainerCount(int $partitionIndex)

Get the total number of containers belonging to a specified partition

array[string] getContainerNames(int $partitionIndex, int $start, int $limit)

Get a array of the Container names belonging to a specified partition

["container1", "container2", "container3"]

int getPartitionIndexOfContainer(string $containerName)

Get the partition index corresponding to the specified Container name

Query

RowSet fetch(boolean $forUpdate=False)

Executes a specified query with the specified option and returns a set of Rows as an execution result

RowSet getRowSet()

Returns RowSet as the latest result

void setFetchOptions(int $limit)

Sets an fetch option for a result acquisition

RowSet

void remove()

Deletes the Row at the current cursor position

object next() ※object: AggregationResult  or array[object]

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

[1, "val"]

RowSetType type

Read-only attribute

int size

Read-only attribute

boolean hasNext()

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

void update(array[object] $row)

Updates the values except a Row key of the Row at the cursor position, using the specified Row object

$row = [1, "val"]

Store

Container putContainer(ContainerInfo $info, boolean $modifiable=False)

Newly creates or update a Container with the specified Container properties

Container getContainer(string $name)

Get a Container instance whose rows can be processed using a Row object

void dropContainer(string $name)

Delete a Container with the specified name

ContainerInfo getContainerInfo(string $name)

Get information related to a Container with the specified name

PartitionController partitionController

Read-only attribute

StoreFactory

@staticmethod StoreFactory getInstance()

Returns a default StoreFactory instance

Store getStore(array[string $name => object $value] $options ) In that, $options is: - host=NULL: A destination host name - port=NULL: A destination port number - clusterName=NULL: A cluster name - database=NULL: Name of the database to be connected - username=NULL: A user name - password=NULL: A password for user authentication - notificationMember=NULL: A list of address and port pairs in cluster - notificationProvider=NULL: A URL of address provider

Returns a Store with the specified properties Note: If this host is multicast address, host/port means notificationAddress/notificationPort for C Client.

$options = ["host" => $argv[1],                      "port" => $argv[2],                      "clusterName" => $argv[3],                      "username" => $argv[4],                      "password" => $argv[5]]

string getVersion()

Returns the current version of client

ContainerInfo

ContainerInfo(array[string $name => object $value] $options) In that, $options is: - name=NULL: Name of container. - columnInfoArray=NULL: List of the information of Columns - type=ContainerType::COLLECTION: Type of container - rowKey=True: The boolean value indicating whether the Row key Column is assigned - expiration=NULL: expiration information of a row

Constructor

$options = ["name" => "containerName", "columnInfoArray" => [["id", Type::INTEGER],                                         ["productName", Type::STRING],                                         ["count", Type::INTEGER]], "type" => ContainerType::COLLECTION, "rowKey" => True, "expiration" => [7, TimeUnit::DAY, 8]]

string name

attribute

array[array[string, Type]] columnInfoArray

attribute

[["ts", Type::TIMESTAMP], ["val", Type::LONG,]]

[["ts", Type::TIMESTAMP], ["val", Type::LONG]]

ContainerType type

attribute

boolean rowKey

attribute

ExpirationInfo expiration

attribute

ExpirationInfo

ExpirationInfo(int $time, TimeUnit $unit, int $divisionCount)

Constructor

int time

attribute

TimeUnit unit

attribute

int divisionCount

attribute

TimestampUtils

@staticmethod int getTimeMillis(DateTime $dt)

Calculate integer-type timestamp in millisecond from DateTime object