Graph Server

Allows to connect to a graph server

pypgx.pg.rdbms.generate_token(base_url, username, password)

Generates a new authentication token.

Parameters
  • base_url – the base URL in the format host [ : port][ /path] of the remote graph server.

  • username – the Database username to use for authentication.

  • password – the Database password to use for authentication.

Returns

the newly generated authentication token

pypgx.pg.rdbms.get_embedded_instance()

Connects to an embedded graph server. An embedded graph server runs inside the client JVM.

Returns

a handle to the embedded graph server

pypgx.pg.rdbms.get_instance(base_url, kerberos_ticket_path, refresh_time_before_token_expiry=1800)

Connects to a remote graph server.

Parameters
  • base_url – the base URL in the format host [ : port][ /path] of the remote graph server. If base_url is None, the default will be used which points to embedded PGX instance.

  • kerberos_ticket_path – the kerberos ticket to be used for authentication.

  • refresh_time_before_token_expiry – the time in seconds to refresh the token automatically before expires.

Returns

a handle to the remote graph server

pypgx.pg.rdbms.reauthenticate(instance, username, password)

Re-authenticates an existing ServerInstance object with a remote graph server.

Parameters
  • instance – the PGX instance on which the session is going to reauthenticate.

  • username – the Database username to use for authentication.

  • password – the Database password to use for authentication.

Returns

the newly generated authentication token