Gremlin Destination Plugin

• Gremlin Server >= 3.6.2
• AWS Neptune >= 1.2

Configuration #

Example #

kind: destination
spec:
  name: "gremlin"
  path: "cloudquery/gremlin"
  registry: "cloudquery"
  version: "v2.5.23"
  spec:
    endpoint: "ws://localhost:8182"
    # Optional parameters
    # auth_mode: none
    # username: ""
    # password: ""
    # aws_region: ""
    # aws_neptune_host: ""
    # max_retries: 5
    # max_concurrent_connections: 5 # default: number of CPUs
    # batch_size: 200
    # batch_size_bytes: 4194304 # 4 MiB

Connecting to AWS Neptune #

Plugin Spec #

• endpoint (string) (required)

  Endpoint for the database. Supported schemes are wss:// and ws://, the default port is 8182.

  • "localhost" (defaults to wss://localhost:8182)
  • "ws://localhost:8182"
  • "wss://your-endpoint.cluster-id.your-region.neptune.amazonaws.com"
• insecure (boolean) (optional)

  Whether to skip TLS verification. Defaults to false. This should be set on a macOS environment when connecting to an AWS Neptune endpoint.
• auth_mode (string) (optional) (default: none)

  Authentication mode to use. basic uses static credentials, aws uses AWS IAM authentication. Supported values are none, basic or aws.
• username (string) (optional)

  Username to connect to the database.
• password (string) (optional)

  Password to connect to the database.
• aws_region (string) (required when auth_mode is aws)

  AWS region to use for AWS IAM authentication. Example: us-east-1.
• aws_neptune_host (string) (optional, used when auth_mode is aws)

  AWS Neptune host header to use with AWS IAM authentication. Use if you're not accessing Neptune directly, when auth_mode is aws. Example: my-neptune.cluster.us-east-1.neptune.amazonaws.com
• max_retries (integer) (optional) (default: 5)

  Number of retries on ConcurrentModificationException before giving up for each batch. Retries are exponentially backed off.
• max_concurrent_connections (integer) (optional) (default: number of CPUs)

  Maximum number of concurrent connections to the database.
• complete_types (boolean) (optional) (default: false)

  Whether to use all Gremlin-supported types or just a basic set. Should remain false for Amazon Neptune compatibility.
• batch_size (integer) (optional) (default: 200)

  Number of records to batch together before sending to the database.
• batch_size_bytes (integer) (optional) (default: 4194304 (4 MiB))

  Number of bytes (as Arrow buffer size) to batch together before sending to the database.