xgt.TableFrame

class xgt.TableFrame(conn, obj)

TableFrame objects represent a table held on the xGT server and can be used to retrieve information about it. These objects are returned with the Connection.get_table_frame() and Connection.create_table_frame() methods, not directly instantiated. A table may also be created by a MATCH query and may contain query results.

Parameters:
  • conn (Connection) – An open connection to an xGT server.
  • obj (json) – Internal table structure expressed in JSON objects.

Examples

>>> import xgt
>>> conn = xgt.Connection()
>>> ... run query and store results in table01
>>> t = conn.get_table_frame('table01')
>>> print(t.name)
__init__(conn, obj)

x.__init__(…) initializes x; see help(type(x)) for signature

Methods

__init__(conn, obj) x.__init__(…) initializes x; see help(type(x)) for signature
get_data([offset, length]) Returns frame data starting at a given offset and spanning a given length.
get_data_pandas([offset, length]) Returns a Pandas DataFrame containing frame data starting at a given offset and spanning a given length.
insert(data) Inserts data rows.
load(paths[, headerMode]) Loads data from a CSV file in the path and the computer indicated by the path.
save(path[, offset, length, headers]) Writes the rows from the frame to a CSV file in the path and the computer indicated by the path.

Attributes

name Name of the table.
num_rows Gets the number of rows of the table.
schema Gets the property names and types of the table.
get_data(offset=0, length=None)

Returns frame data starting at a given offset and spanning a given length.

Parameters:
  • offset (int) – Position (index) of the first row to be retrieved. Optional. Default=0.
  • length (int) – Maximum number of rows to be retrieved starting from the row indicated by offset. A value of ‘None’ means ‘all rows’ on and after the offset. Optional. Default=None.
Returns:
Return type:

list of lists
get_data_pandas(offset=0, length=None)

Returns a Pandas DataFrame containing frame data starting at a given offset and spanning a given length.

Parameters:
  • offset (int) – Position (index) of the first row to be retrieved. Optional. Default=0.
  • length (int) – Maximum number of rows to be retrieved starting from the row indicated by offset. A value of ‘None’ means ‘all rows’ on and after the offset. Optional. Default=None.
Returns:
Return type:

Pandas DataFrame
insert(data)

Inserts data rows. The properties of the new data must match the schema in both order and type.

Parameters:data (list or Pandas dataframe) – Data represented by a list of lists of data items or by a Pandas Dataframe.
load(paths, headerMode=0)

Loads data from a CSV file in the path and the computer indicated by the path.

Parameters:
  • paths (list) –

    Paths to the CSV files.

    Syntax for one CSV file path
    Resource type Path syntax
    local to python: ’<absolute path to csv file>’
    xgtd computer: ’xgtd://<absolute path to csv file>’
    AWS s3: ’s3://<absolute path to csv file>’
    https site: ’https://<absolute path to csv file>’
    http site: ’http://<absolute path to csv file>’
    ftps server: ’ftps://<absolute path to csv file>’
  • headerMode (str) –
    Indicates if the files contain headers:
    • HeaderMode.NONE
    • HeaderMode.IGNORE
    • HeaderMode.NORMAL
    • HeaderMode.STRICT

    Optional. Default=HeaderMode.NONE.
name

Name of the table.

Type:str
num_rows

Gets the number of rows of the table.

Type:int
save(path, offset=0, length=None, headers=False)

Writes the rows from the frame to a CSV file in the path and the computer indicated by the path.

Parameters:
  • path (str) –

    Path to the CSV file.

    Syntax for one CSV file path
    Resource type Path syntax
    local to python: ’<absolute path to csv file>’
    xgtd computer: ’xgtd://<absolute path to csv file>’
    AWS s3: ’s3://<absolute path to csv file>’
    https site: ’https://<absolute path to csv file>’
    http site: ’http://<absolute path to csv file>’
    ftps server: ’ftps://<absolute path to csv file>’
  • offset (int) – Position (index) of the first row to be retrieved. Optional. Default=0.
  • length (int) – Maximum number of rows to be retrieved. Optional. Default=None.
  • headers (boolean) – Indicates if headers should be added. Optional. Default=False.
schema

Gets the property names and types of the table.

Type:list of lists