5.2. General

Functions or classes often used to interact with the server.

Connection(host, port, flags, ...)

Connection to the server with functionality to create, change, and remove graph structures and run jobs.

BasicAuth([username, password])

Basic authentication mechanism with user id and password.

KerberosAuth([principal])

Kerberos-based single-sign on authentication.

PKIAuth([ssl_root_dir, ssl_server_cert, ...])

PKI-based authentication.

ProxyPKIAuth([ssl_root_dir, ...])

PKI-based authentication through a proxy.

TrustedProxyAuth(userid[, ssl_root_dir, ...])

PKI-based authentication through a trusted proxy.

BearerTokenAuth(access_token)

Bearer-token authentication for direct OIDC/JWT login.

OidcClientConfig([issuer, client_id, ...])

Base configuration for OIDC authentication.

OidcAuth([issuer, client_id, scopes, ...])

Interactive OIDC authentication.

OidcAuthorizationCodeAuth([issuer, ...])

Compatibility wrapper for OidcAuth(flow='auth_code').

OidcCredentialsAuth([issuer, client_id, ...])

Client-credentials authentication for headless/scripted OIDC login.

OidcTokenCache(config)

Manages a single JSON token file on disk for a given OidcClientConfig.

cached_oidc_auth(config[, force_login, ...])

Return a valid BearerTokenAuth, using the cache where possible.

cached_credentials_auth(config)

Return a valid BearerTokenAuth for a service client, using the cache.

Job(conn[, job_response, python_errors, ...])

Represents a user-scheduled Job.

JobFilter([status, start_date, end_date, ...])

Filter criteria for Connection.get_jobs() and Connection.get_job_stats().

JobProgress(phase, substep, rows_processed, ...)

Live execution progress for a running job, from Job.progress.

RowID(container_map, row_id_list)

RowID represents a row ID returned from a server.

TableRow([mapping, container_map, validation_id])

Represents a row from a table frame providing access to the row properties and the frame the row belongs to.

Vertex([mapping, container_map, validation_id])

Represents a vertex from a vertex frame providing access to the properties and the frame the vertex belongs to.

Edge([mapping, container_map, validation_id])

Represents an edge from an edge frame providing access to the properties and the frame the edge belongs to.

OnMissingVertices()

Controls the behavior of an edge load when an edge references a source or target vertex key that does not exist in the endpoint vertex frame.