• Home
• airflow.providers.apache.tinkerpop
• airflow.providers.apache.tinkerpop.hooks
• airflow.providers.apache.tinkerpop.hooks.gremlin

airflow.providers.apache.tinkerpop.hooks.gremlin

This module allows connecting to an Graph DB using the Gremlin Client.

Attributes

logger

Classes

GremlinHook

Interact with Graph DB using the Gremlin Client.

Module Contents

airflow.providers.apache.tinkerpop.hooks.gremlin.logger

class airflow.providers.apache.tinkerpop.hooks.gremlin.GremlinHook(conn_id=default_conn_name, *args, **kwargs)

Bases: airflow.hooks.base.BaseHook

Interact with Graph DB using the Gremlin Client.

This hook creates a connection to Graph DB and allows you to run Gremlin queries.`

Parameters:

gremlin_conn_id – Reference to the connection ID configured in Airflow.

conn_name_attr = 'gremlin__conn_id'

default_conn_name = 'gremlin_default'

conn_type = 'gremlin'

hook_name = 'Gremlin'

default_port = 443

traversal_source = 'g'

gremlin_conn_id = 'gremlin_default'

connection

client: gremlin_python.driver.client.Client | None = None

get_conn(serializer=None)

Establish a connection to Graph DB with the Gremlin Client.

Parameters:

serializer – Message serializer to use for the client.

Returns:

An instance of the Gremlin Client.

Return type:

gremlin_python.driver.client.Client

get_uri(conn)

Build the URI from the connection object and extra parameters.

Parameters:

conn (airflow.models.Connection) – Airflow Connection object.

Returns:

URI string.

Return type:

str

get_client(conn, traversal_source, uri, message_serializer=None)

Create and return a new Gremlin client.

Parameters:

• conn (airflow.models.Connection) – Airflow Connection object.

• traversal_source (str) – Traversal source for the Gremlin client.

• uri (str) – URI string for connecting to Graph DB.

• message_serializer – Message serializer to use for the client.

Returns:

An instance of the Gremlin Client.

Return type:

gremlin_python.driver.client.Client

run(query, serializer=None, bindings=None, request_options=None)

Execute a Gremlin query and return the results.

Parameters:

• query (str) – Gremlin query string.

• serializer – Message serializer to use for the query.

• bindings – Bindings to use for the query.

• request_options – Request options to use for the query.

Returns:

List containing the query results.

Return type:

list[Any]

Previous Next

Was this entry helpful?