genai-toolbox/docs/en/resources/sources/dgraph.md at 1664a69dfd2789bc7fc63cd0aebc9ca5dbc81672

mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-02-11 15:45:06 -05:00

Files

Yuan Teoh 293c1d6889 feat!: update configuration file v2 (#2369 )

This PR introduces a significant update to the Toolbox configuration
file format, which is one of the primary **breaking changes** required
for the implementation of the Advanced Control Plane.

# Summary of Changes
The configuration schema has been updated to enforce resource isolation
and facilitate atomic, incremental updates.
* Resource Isolation: Resource definitions are now separated into
individual blocks, using a distinct structure for each resource type
(Source, Tool, Toolset, etc.). This improves readability, management,
and auditing of configuration files.
* Field Name Modification: Internal field names have been modified to
align with declarative methodologies. Specifically, the configuration
now separates kind (general resource type, e.g., Source) from type
(specific implementation, e.g., Postgres).

# User Impact
Existing tools.yaml configuration files are now in an outdated format.
Users must eventually update their files to the new YAML format.

# Mitigation & Compatibility
Backward compatibility is maintained during this transition to ensure no
immediate user action is required for existing files.
* Immediate Backward Compatibility: The source code includes a
pre-processing layer that automatically detects outdated configuration
files (v1 format) and converts them to the new v2 format under the hood.
* [COMING SOON] Migration Support: The new toolbox migrate subcommand
will be introduced to allow users to automatically convert their old
configuration files to the latest format.

# Example
Example for config file v2:
```
kind: sources
name: my-pg-instance
type: cloud-sql-postgres
project: my-project
region: my-region
instance: my-instance
database: my_db
user: my_user
password: my_pass
---
kind: authServices
name: my-google-auth
type: google
clientId: testing-id
---
kind: tools
name: example_tool
type: postgres-sql
source: my-pg-instance
description: some description
statement: SELECT * FROM SQL_STATEMENT;
parameters:
- name: country
  type: string
  description: some description
---
kind: tools
name: example_tool_2
type: postgres-sql
source: my-pg-instance
description: returning the number one
statement: SELECT 1;
---
kind: toolsets
name: example_toolset
tools:
- example_tool
```

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Averi Kitsch <akitsch@google.com>

2026-01-27 16:58:43 -08:00

3.0 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

{{< notice note >}} ⚠️ Best Effort Maintenance

This integration is maintained on a best-effort basis by the project team/community. While we strive to address issues and provide workarounds when resources are available, there are no guaranteed response times or code fixes.

The automated integration tests for this module are currently non-functional or failing. {{< /notice >}}

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.

Available Tools

dgraph-dql
Run DQL (Dgraph Query Language) queries.

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

kind: sources
name: my-dgraph-source
type: 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
type	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).

3.0 KiB Raw Blame History