Home Manual Reference Source
public class | source

Gda

Extends:

src/mapping/core.js~Service → Gda

GDA User API

User API for Generic Data Access. The data are stored on a per-user basis. Users can put, get, list their data.

Static Member Summary

Static Public Members
public static get

Get default deployment id associated to Gda service

Method Summary

Public Methods
public

get(objectPattern: {"table": *, "key": *, "owner": *}): *

Asks for a data row

public

getCells(objectPattern: {"table": *, "key": *, "key2": *, "owner": *, "column": *}): *

Asks for a data cell

public

inc(objectPattern: {"table": *, "data": *, "key": *, "key2": *, "owner": *, "column": *}): *

Increments an integer value

public

list(objectPattern: {"columns": *, "table": *, "owner": *, "page": *}): *

Asks for a list of rows

public

put(objectPattern: {"table": *, "data": *, "key": *, "key2": *, "owner": *, "column": *}): *

Puts some data into a cell

public

puts(objectPattern: {"rows": *, "table": *, "owner": *}): *

Puts several rows

public

range(objectPattern: {"columns": *, "start": *, "table": *, "stop": *, "owner": *, "page": *}): *

Asks for a range of rows

public

removeCell(objectPattern: {"table": *, "key": *, "key2": *, "owner": *, "column": *}): *

Removes one cell inside a column of a row

public

removeColumn(objectPattern: {"table": *, "key": *, "owner": *, "column": *}): *

Removes one full column of a row

public

removeRange(objectPattern: {"columns": *, "start": *, "table": *, "stop": *, "owner": *}): *

Removes a range of rows

public

removeRow(objectPattern: {"table": *, "key": *, "owner": *}): *

Removes one full row

Static Public Members

public static get DEFAULT_DEPLOYMENT_ID: string: string source

Get default deployment id associated to Gda service

Return:

string

Public Methods

public get(objectPattern: {"table": *, "key": *, "owner": *}): * source

Asks for a data row

Returns a full data row.

Params:

NameTypeAttributeDescription
objectPattern {"table": *, "key": *, "owner": *}
  • default: {"table":null,"key":null,"owner":null}

Return:

*

public getCells(objectPattern: {"table": *, "key": *, "key2": *, "owner": *, "column": *}): * source

Asks for a data cell

Returns a precise list of cells from a column in a data row.

Params:

NameTypeAttributeDescription
objectPattern {"table": *, "key": *, "key2": *, "owner": *, "column": *}
  • default: {"table":null,"key":null,"key2":null,"owner":null,"column":null}

Return:

*

public inc(objectPattern: {"table": *, "data": *, "key": *, "key2": *, "owner": *, "column": *}): * source

Increments an integer value

Increments a cell 64-bit signed integer value and returns the result in the data field. The increment is atomic : if you concurrently increment 10 times a value by 1, the final result will be the initial value plus 10. The actual individual resulting values seen by the 10 concurrent callers may vary discontinuously, with duplicates : at least one of them will see the final (+10) result.

Params:

NameTypeAttributeDescription
objectPattern {"table": *, "data": *, "key": *, "key2": *, "owner": *, "column": *}
  • default: {"table":null,"data":null,"key":null,"key2":null,"owner":null,"column":null}

Return:

*

public list(objectPattern: {"columns": *, "table": *, "owner": *, "page": *}): * source

Asks for a list of rows

Returns a paginated list of rows from the given table.

Params:

NameTypeAttributeDescription
objectPattern {"columns": *, "table": *, "owner": *, "page": *}
  • default: {"columns":null,"table":null,"owner":null,"page":null}

Return:

*

public put(objectPattern: {"table": *, "data": *, "key": *, "key2": *, "owner": *, "column": *}): * source

Puts some data into a cell

Creates or replaces the contents of a particular cell.

Params:

NameTypeAttributeDescription
objectPattern {"table": *, "data": *, "key": *, "key2": *, "owner": *, "column": *}
  • default: {"table":null,"data":null,"key":null,"key2":null,"owner":null,"column":null}

Return:

*

public puts(objectPattern: {"rows": *, "table": *, "owner": *}): * source

Puts several rows

Creates or replaces the (maybe partial) contents of a collection of rows. This method only creates or replaces cells for non-null input values.

Params:

NameTypeAttributeDescription
objectPattern {"rows": *, "table": *, "owner": *}
  • default: {"rows":null,"table":null,"owner":null}

Return:

*

public range(objectPattern: {"columns": *, "start": *, "table": *, "stop": *, "owner": *, "page": *}): * source

Asks for a range of rows

Returns a paginated range of rows from the given table. A range consists of consecutive rows from the start key (inclusive) to the stop key (exclusive). You can specify partial keys for the start and stop fields.

Params:

NameTypeAttributeDescription
objectPattern {"columns": *, "start": *, "table": *, "stop": *, "owner": *, "page": *}
  • default: {"columns":null,"start":null,"table":null,"stop":null,"owner":null,"page":null}

Return:

*

public removeCell(objectPattern: {"table": *, "key": *, "key2": *, "owner": *, "column": *}): * source

Removes one cell inside a column of a row

Removes only one cell of the given column of the given row from the given table.

Params:

NameTypeAttributeDescription
objectPattern {"table": *, "key": *, "key2": *, "owner": *, "column": *}
  • default: {"table":null,"key":null,"key2":null,"owner":null,"column":null}

Return:

*

public removeColumn(objectPattern: {"table": *, "key": *, "owner": *, "column": *}): * source

Removes one full column of a row

Removes all cells of the given column of the given row from the given table.

Params:

NameTypeAttributeDescription
objectPattern {"table": *, "key": *, "owner": *, "column": *}
  • default: {"table":null,"key":null,"owner":null,"column":null}

Return:

*

public removeRange(objectPattern: {"columns": *, "start": *, "table": *, "stop": *, "owner": *}): * source

Removes a range of rows

Removes the specified columns of the given range of rows from the given table.

Params:

NameTypeAttributeDescription
objectPattern {"columns": *, "start": *, "table": *, "stop": *, "owner": *}
  • default: {"columns":null,"start":null,"table":null,"stop":null,"owner":null}

Return:

*

public removeRow(objectPattern: {"table": *, "key": *, "owner": *}): * source

Removes one full row

Removes all columns of the given row from the given table.

Params:

NameTypeAttributeDescription
objectPattern {"table": *, "key": *, "owner": *}
  • default: {"table":null,"key":null,"owner":null}

Return:

*