Utility Functions

Utility functions for pyTigerGraph. All functions in this module are called as methods on a TigerGraphConnection object.

echo()

echo(usePost: bool = False) → str

Pings the database.

Parameter:

  • usePost: Use POST instead of GET

Returns:

"Hello GSQL" if everything was OK.

Endpoint:

  • GET /echo

  • POST /echo See Echo

getVersion()

getVersion(raw: bool = False) → Union[str, list]

Retrieves the git versions of all components of the system.

Parameter:

  • raw: Return unprocessed version info string, or extract version info for each component into a list.

Returns:

Either an unprocessed string containing the version info details, or a list with version info for each component.

Endpoint:

getVer()

getVer(component: str = "product", full: bool = False) → str

Gets the version information of a specific component.

Get the full list of components using getVersion().

Parameters:

  • component: One of TigerGraph’s components (e.g. product, gpe, gse).

  • full: Return the full version string (with timestamp, etc.) or just X.Y.Z.

Returns:

Version info for specified component.

Raises:

TigerGraphException if invalid/non-existent component is specified.

getLicenseInfo()

getLicenseInfo() → dict

Returns the expiration date and remaining days of the license.

Returns:

Returns license details. For an evaluation/trial deployment, returns an information message and -1 remaining days.