docs: GraphDB Client #3383

edmondchuc · 2026-01-30T14:03:41Z

Summary of changes

This PR adds user docs for the PR #3372.

The preview link is at: https://rdflib--3383.org.readthedocs.build/en/3383/graphdb/

Checklist

Checked that there aren't other open pull requests for
the same change.
Checked that all tests and type checking passes.
If the change adds new features or changes the RDFLib public API:
- Created an issue to discuss the change and get in-principle agreement.
- Considered adding an example in ./examples.
If the change has a potential impact on users of this project:
- Added or updated tests that fail without the change.
- Updated relevant documentation to avoid inaccuracies.
- Considered adding additional documentation.
Considered granting push permissions to the PR branch,
so maintainers can fix minor issues and keep your PR up to date.

nelly-hateva · 2026-01-30T14:46:26Z

docs/graphdb.md

+
+### Creating a client instance
+
+The [`GraphDBClient`][rdflib.contrib.graphdb.client.GraphDBClient] class is the main entry point for interacting with the GraphDB REST API. To create an instance, pass the base URL of the GraphDB server to the constructor and optionally a username and password tuple for basic authentication.


Not sure about this one, but is the idea to add a link to the class? Currently, this is poorly rendered IMO

This is mkdocstring syntax to link to the class doc. Could you clarify what part is poorly rendered?

Got it, tnx. Sorry, I was not looking at https://rdflib--3383.org.readthedocs.build/en/3383/graphdb/, I was looking at the file https://github.com/RDFLib/rdflib/blob/632e0f877c8ed0ed03b189d776ce5ba050931067/docs/graphdb.md from the browser.

nelly-hateva · 2026-01-30T14:44:38Z

docs/graphdb.md

+
+```python
+from rdflib.contrib.graphdb.client import GraphDBClient
+


This example is very confusing. We pass "admin"/"root" twice and have two different clients. Can we provide an example, where we login a user, which is not the admin ?

I've changed the login example to a separate user in commit 78b938d

So, if GraphDB security is enabled, one must use the admin user to create a client in order to login the other user? This looks very fishy

Any user who wants to retrieve a GDB token can use this method. How they use the token is up to them, but I’ve provided a simple example showing how it can also be used with the GraphDBClient.

I've updated the doc example in commit 60e82f4 - hopefully this makes it clearer.

edmondchuc · 2026-01-30T15:02:28Z

docs/graphdb.md

+
+```python
+size_info = client.repos.size("my-repo")
+print(f"Size: {size_info.size}")


This is fixed in bff4aef

edmondchuc · 2026-01-30T15:21:53Z

docs/graphdb.md

+
+##### Querying an agent
+
+To send a natural language query to an agent:


I’ve updated it (in commit bd4b4a3) to use more general LLM language and specified sparql_query in the example. I’ve avoided re-listing the possible tool types here since they are already documented in the GraphDB docs, and I’d prefer to keep this aligned with the upstream source rather than duplicate it.

I don't think "To send a query to an agent:" is accurate. I prefer to phrase it as in the GraphDB documents Call agent query method/assistant tool. Also the query in the example must be a valid SPARQL query, for example ask {?s ?p ?o}

Great, thanks for the pointers. I've updated the text to reflect your suggestions in 935c91a.

As requested, TTYG is now removed in commit dd1bd30.

edmondchuc added 10 commits January 22, 2026 07:52

docs: add mkdocs wiring

481ce40

docs: graphdb checkpoint

70cc93f

Merge branch 'v7/feat/graphdb' into v7/docs/graphdb

ba0dc68

docs: graphdb docs checkpoint

74ab7d6

Merge branch 'v7/feat/graphdb' into v7/docs/graphdb

033efd0

docs: graphdb checkpoint

3e3d67d

docs: add RDF4JClient connection pooling info

b5d9bb9

docs: graphdb checkpoint

01dfb70

Merge branch 'v7/feat/graphdb' into v7/docs/graphdb

4731fbd

docs: graphdb add UserCreate update

632e0f8

edmondchuc mentioned this pull request Jan 30, 2026

feat: GraphDB Client #3372

Open

8 tasks

nelly-hateva reviewed Jan 30, 2026

View reviewed changes

edmondchuc added 2 commits January 31, 2026 00:57

docs: fix casing and typos

bff4aef

docs: update auth example

78b938d

nelly-hateva reviewed Jan 30, 2026

View reviewed changes

edmondchuc added 7 commits January 31, 2026 01:18

docs: update ttyg

bd4b4a3

docs: update ttyg

935c91a

docs: remove ttyg

dd1bd30

docs: improve GDB token example

60e82f4

Merge branch 'v7/feat/graphdb' into v7/docs/graphdb

9441382

docs: update to the new GraphDBClient graphdb_repositories namespace

74d8e98

docs: update rdf4j.md to mention transaction thread-safety warning

8e959b0


		### Creating a client instance

		The [`GraphDBClient`][rdflib.contrib.graphdb.client.GraphDBClient] class is the main entry point for interacting with the GraphDB REST API. To create an instance, pass the base URL of the GraphDB server to the constructor and optionally a username and password tuple for basic authentication.


		```python
		from rdflib.contrib.graphdb.client import GraphDBClient


		##### Querying an agent

		To send a natural language query to an agent:

docs: GraphDB Client #3383

Are you sure you want to change the base?

docs: GraphDB Client #3383

Conversation

edmondchuc commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Checklist

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nelly-hateva Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

edmondchuc commented Jan 30, 2026 •

edited

Loading

nelly-hateva Jan 30, 2026 •

edited

Loading