xgt.VertexFrame

class xgt.VertexFrame(conn, obj)

VertexFrame objects represent a collection of vertices held on the xGT server and can be used to retrieve information about them. These objects are returned by the Connection.get_vertex_frame() method and the Connection.create_vertex_frame() method.

Each vertex in a VertexFrame shares the same properties, described in VertexFrame.schema. Each vertex in a VertexFrame is uniquely identified by the property listed in VertexFrame.key.

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

Examples

>>> import xgt
>>> conn = xgt.Connection()
>>> v1 = conn.create_vertex_frame(
...          name = 'Person',
...          schema = [['id', xgt.INT],
...                    ['name', xgt.TEXT]],
...          key = 'id')
>>> v2 = conn.get_vertex_frame('Company') #Company is an existing vertex type
>>> print(v1.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

key Gets the property name that uniquely identifies vertices of this type.
name Name of the vertex frame.
num_rows Gets the number of rows of the table.
num_vertices Gets the number of vertices in the VertexFrame.
schema Gets the property names and types of the vertex frame.
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.
key

Gets the property name that uniquely identifies vertices of this type.

Type:str
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 vertex frame.

Type:str
num_rows

Gets the number of rows of the table.

Type:int
num_vertices

Gets the number of vertices in the VertexFrame.

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 vertex frame.

Type:list of lists