genai-toolbox/docs/en/resources/sources/dgraph.md at 032b33396140bcdc78e05090dfb8eea071da2d0a

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-02-13 00:25:10 -05:00

Files

Wenxin Du eadb678a7b feat: Support env replacement for tool.yaml (#462 )

Environment variable replacement is needed so that users don't have to
hardcode their secrets in configuring `tools.yaml`.
Both formats `$ENV_NAME` and `${ENV_NAME}` are standard ways to declare
an environment variable.
However, some database statement placeholders that are already using the
`$ENV_NAME` format.
Therefore, we only support env var declaration using `${ENV_NAME}` to
disambiguate it from other usages.

Fixes issue: https://github.com/googleapis/genai-toolbox/issues/431

2025-04-23 07:33:02 -04:00

2.5 KiB

Raw Blame History

title, type, weight, description

title	type	weight	description
Dgraph	docs	1	Dgraph is fully open-source, built-for-scale graph database for Gen AI workloads

About

Dgraph is an open-source graph database. It is designed for real-time workloads, horizontal scalability, and data flexibility. Implemented as a distributed system, Dgraph processes queries in parallel to deliver the fastest result.

This source can connect to either a self-managed Dgraph cluster or one hosted on Dgraph Cloud. If you're new to Dgraph, the fastest way to get started is to sign up for Dgraph Cloud.

Requirements

Database User

When connecting to a hosted Dgraph database, this source uses the API key for access. If you are using a dedicated environment, you will additionally need the namespace and user credentials for that namespace.

For connecting to a local or self-hosted Dgraph database, use the namespace and user credentials for that namespace.

Example

sources:
    my-dgraph-source:
        kind: dgraph
        dgraphUrl: https://xxxx.cloud.dgraph.io
        user: ${USER_NAME}
        password: ${PASSWORD}
        apiKey: ${API_KEY}
        namespace : 0

{{< notice tip >}} Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file. {{< /notice >}}

Reference

Field	Type	Required	Description
kind	string	true	Must be "dgraph".
dgraphUrl	string	true	Connection URI (e.g. "https://xxx.cloud.dgraph.io", "https://localhost:8080").
user	string	false	Name of the Dgraph user to connect as (e.g., "groot").
password	string	false	Password of the Dgraph user (e.g., "password").
apiKey	string	false	API key to connect to a Dgraph Cloud instance.
namespace	uint64	false	Dgraph namespace (not required for Dgraph Cloud Shared Clusters).

2.5 KiB Raw Blame History