Skip to content

client

GraphDB client module.

Classes:

Attributes:

FileContent module-attribute 

FileContent = Union[bytes, str, IO[bytes], Tuple[Optional[str], Union[bytes, str, IO[bytes]]], Tuple[Optional[str], Union[bytes, str, IO[bytes]], Optional[str]]]

FilesType module-attribute 

FilesType = Union[Mapping[str, FileContent], Iterable[Tuple[str, FileContent]]]

AccessControlListManagement 

AccessControlListManagement(identifier: str, http_client: Client)

Manage fine-grained access control lists for GraphDB repositories.

Methods:

  • add –

    Add ACL rules to the repository.

  • delete –

    Delete ACL rules from the repository.

  • list –

    List ACL rules for the repository.

  • set –

    Set ACL rules for the repository.

Attributes:

Source code in rdflib/contrib/graphdb/client.py 
81
82
83
def __init__(self, identifier: str, http_client: httpx.Client):
    self._identifier = identifier
    self._http_client = http_client

http_client property 

http_client

identifier property 

identifier

Repository identifier.

add 

add(acl_rules: Sequence[AccessControlEntry], position: int | None = None)

Add ACL rules to the repository.

You can also provide an optional URL request parameter position that specifies the position of the rules to be added. The position is zero-based (0 is the first position). If the position parameter is not provided, the rules are added at the end of the list.

Parameters:

  • acl_rules

    (Sequence[AccessControlEntry]) –

    The list of ACL rules to add.

  • position

    (int | None, default: None ) –

    The zero-based position to add the rules at.

Raises:

  • BadRequestError –

    If the request is invalid.

  • UnauthorisedError –

    If the request is unauthorised.

  • ForbiddenError –

    If the request is forbidden.

  • InternalServerError –

    If the server returns an internal error.

  • ValueError –

    If the position is not an integer or is a negative integer.

  • ValueError –

    If the ACL rules are not provided as a sequence or are not AccessControlEntry instances.

Source code in rdflib/contrib/graphdb/client.py 
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
def add(
    self, acl_rules: t.Sequence[AccessControlEntry], position: int | None = None
):
    """
    Add ACL rules to the repository.

    You can also provide an optional URL request parameter position that specifies the position of the rules to be added.
    The position is zero-based (0 is the first position). If the position parameter is not provided, the rules are added at
    the end of the list.

    Parameters:
        acl_rules: The list of ACL rules to add.
        position: The zero-based position to add the rules at.

    Raises:
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        InternalServerError: If the server returns an internal error.
        ValueError: If the position is not an integer or is a negative integer.
        ValueError: If the ACL rules are not provided as a sequence or are not AccessControlEntry instances.
    """
    acl_rules_list = list(acl_rules)
    if any(not isinstance(rule, AccessControlEntry) for rule in acl_rules_list):
        raise ValueError("All ACL rules must be AccessControlEntry instances.")

    payload = [rule.as_dict() for rule in acl_rules_list]
    headers = {"Content-Type": "application/json"}
    params = {}
    if position is not None:
        if not isinstance(position, int):
            raise ValueError("Position must be an integer.")
        if position < 0:
            raise ValueError("Position must be a positive integer.")
        params["position"] = str(position)
    try:
        response = self._http_client.post(
            f"/rest/repositories/{self.identifier}/acl",
            headers=headers,
            json=payload,
            params=params,
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

delete 

delete(acl_rules: Sequence[AccessControlEntry])

Delete ACL rules from the repository.

The provided FGAC rules are removed from the list regardless of their position.

Parameters:

Raises:

Source code in rdflib/contrib/graphdb/client.py 
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
def delete(self, acl_rules: t.Sequence[AccessControlEntry]):
    """
    Delete ACL rules from the repository.

    The provided FGAC rules are removed from the list regardless of their position.

    Parameters:
        acl_rules: The list of ACL rules to delete.

    Raises:
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        InternalServerError: If the server returns an internal error.
        ValueError: If the ACL rules are not provided as a sequence or are not AccessControlEntry instances.
    """
    acl_rules_list = list(acl_rules)
    if any(not isinstance(rule, AccessControlEntry) for rule in acl_rules_list):
        raise ValueError("All ACL rules must be AccessControlEntry instances.")

    payload = [rule.as_dict() for rule in acl_rules_list]
    headers = {"Content-Type": "application/json"}
    try:
        response = self._http_client.request(
            method="DELETE",
            url=f"/rest/repositories/{self.identifier}/acl",
            headers=headers,
            json=payload,
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

list 

list(scope: Literal['statement', 'clear_graph', 'plugin', 'system'] | None = None, operation: Literal['read', 'write', '*'] | None = None, subject: str | URIRef | None = None, predicate: str | URIRef | None = None, obj: str | URIRef | Literal | None = None, graph: Literal['*', 'named', 'default'] | URIRef | Graph | None = None, plugin: str | None = None, role: str | None = None, policy: Literal['allow', 'deny', 'abstain'] | None = None) -> List[SystemAccessControlEntry | StatementAccessControlEntry | PluginAccessControlEntry | ClearGraphAccessControlEntry]

List ACL rules for the repository.

Parameters:

  • scope

    (Literal['statement', 'clear_graph', 'plugin', 'system'] | None, default: None ) –

    The scope of the FGAC rule (statement, clear_graph, plugin, system).

  • operation

    (Literal['read', 'write', '*'] | None, default: None ) –

    The operation of the FGAC rule (read, write, *).

  • subject

    (str | URIRef | None, default: None ) –

    The subject of the FGAC rule in Turtle format (for example, <http://example.com/Mary>).

  • predicate

    (str | URIRef | None, default: None ) –

    The predicate of the FGAC rule in Turtle format (for example, <http://www.w3.org/2000/01/rdf-schema#label>).

  • obj

    (str | URIRef | Literal | None, default: None ) –

    The object of the FGAC rule in Turtle format (for example, "Mary"@en).

  • graph

    (Literal['*', 'named', 'default'] | URIRef | Graph | None, default: None ) –

    The graph of the FGAC rule in Turtle format (for example, <http://example.org/graphs/graph1>).

  • plugin

    (str | None, default: None ) –

    The plugin name for the FGAC rule with plugin scope (for example, elasticsearch-connector).

  • role

    (str | None, default: None ) –

    The role associated with the FGAC rule.

  • policy

    (Literal['allow', 'deny', 'abstain'] | None, default: None ) –

    The policy for the FGAC rule (allow, deny, abstain).

Returns:

Raises:

Source code in rdflib/contrib/graphdb/client.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
def list(
    self,
    scope: t.Literal["statement", "clear_graph", "plugin", "system"] | None = None,
    operation: t.Literal["read", "write", "*"] | None = None,
    subject: str | URIRef | None = None,
    predicate: str | URIRef | None = None,
    obj: str | URIRef | Literal | None = None,
    graph: t.Literal["*", "named", "default"] | URIRef | Graph | None = None,
    plugin: str | None = None,
    role: str | None = None,
    policy: t.Literal["allow", "deny", "abstain"] | None = None,
) -> t.List[
    SystemAccessControlEntry
    | StatementAccessControlEntry
    | PluginAccessControlEntry
    | ClearGraphAccessControlEntry
]:
    """
    List ACL rules for the repository.

    Parameters:
        scope: The scope of the FGAC rule (`statement`, `clear_graph`, `plugin`, `system`).
        operation: The operation of the FGAC rule (`read`, `write`, `*`).
        subject: The subject of the FGAC rule in Turtle format (for example, `<http://example.com/Mary>`).
        predicate: The predicate of the FGAC rule in Turtle format (for example, `<http://www.w3.org/2000/01/rdf-schema#label>`).
        obj: The object of the FGAC rule in Turtle format (for example, `"Mary"@en`).
        graph: The graph of the FGAC rule in Turtle format (for example, `<http://example.org/graphs/graph1>`).
        plugin: The plugin name for the FGAC rule with plugin scope (for example, `elasticsearch-connector`).
        role: The role associated with the FGAC rule.
        policy: The policy for the FGAC rule (`allow`, `deny`, `abstain`).

    Returns:
        A list of FGAC rules.

    Raises:
        ValueError: If the parameters are invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        InternalServerError: If the server returns an internal error.
        ResponseFormatError: If the response cannot be parsed.
    """
    params: dict[str, str] = {}
    if scope is not None:
        if scope not in _ALLOWED_FGAC_SCOPES:
            raise ValueError(f"Invalid FGAC scope filter: {scope!r}")
        params["scope"] = scope
    if operation is not None:
        params["operation"] = _parse_operation(operation)
    if subject is not None:
        if isinstance(subject, URIRef):
            params["subject"] = subject.n3()
        elif isinstance(subject, str):
            params["subject"] = subject
        else:
            raise ValueError(f"Invalid FGAC subject filter: {subject!r}")
    if predicate is not None:
        if isinstance(predicate, URIRef):
            params["predicate"] = predicate.n3()
        elif isinstance(predicate, str):
            params["predicate"] = predicate
        else:
            raise ValueError(f"Invalid FGAC predicate filter: {predicate!r}")
    if obj is not None:
        if isinstance(obj, (URIRef, Literal)):
            params["object"] = obj.n3()
        elif isinstance(obj, str):
            params["object"] = obj
        else:
            raise ValueError(f"Invalid FGAC object filter: {obj!r}")
    if graph is not None:
        if isinstance(graph, URIRef):
            params["context"] = graph.n3()
        elif isinstance(graph, Graph):
            params["context"] = graph.identifier.n3()
        elif isinstance(graph, str):
            params["context"] = graph
        else:
            raise ValueError(f"Invalid FGAC graph filter: {graph!r}")
    if plugin is not None:
        params["plugin"] = _parse_plugin(plugin)
    if role is not None:
        params["role"] = _parse_role(role)
    if policy is not None:
        params["policy"] = _parse_policy(policy)

    try:
        response = self._http_client.get(
            f"/rest/repositories/{self.identifier}/acl", params=params
        )
        response.raise_for_status()
        try:
            payload = response.json()
        except (ValueError, TypeError) as err:
            raise ResponseFormatError(
                f"Failed to parse GraphDB response: {err}"
            ) from err

        if not isinstance(payload, list):
            raise ResponseFormatError(
                "Failed to parse GraphDB response: expected a list of ACL entries."
            )

        try:
            return [AccessControlEntry.from_dict(acl) for acl in payload]
        except (ValueError, TypeError) as err:
            raise ResponseFormatError(
                f"Failed to parse GraphDB response: {err}"
            ) from err
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

set 

set(acl_rules: Sequence[AccessControlEntry])

Set ACL rules for the repository.

Note

This method overwrites existing ACL rules in the repository. If you want to add new rules without overwriting existing ones, use the add method.

Parameters:

Raises:

Source code in rdflib/contrib/graphdb/client.py 
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
def set(self, acl_rules: t.Sequence[AccessControlEntry]):
    """
    Set ACL rules for the repository.

    !!! Note
        This method overwrites existing ACL rules in the repository.
        If you want to add new rules without overwriting existing ones,
        use the [`add`][rdflib.contrib.graphdb.client.AccessControlListManagement.add] method.

    Parameters:
        acl_rules: The list of ACL rules to set.

    Raises:
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        InternalServerError: If the server returns an internal error.
        ValueError: If the ACL rules are not provided as a sequence or are not AccessControlEntry instances.
    """
    acl_rules_list = list(acl_rules)
    if any(not isinstance(rule, AccessControlEntry) for rule in acl_rules_list):
        raise ValueError("All ACL rules must be AccessControlEntry instances.")

    payload = [rule.as_dict() for rule in acl_rules_list]
    headers = {"Content-Type": "application/json"}
    try:
        response = self._http_client.put(
            f"/rest/repositories/{self.identifier}/acl",
            headers=headers,
            json=payload,
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

ClusterGroupManagement 

ClusterGroupManagement(http_client: Client)

Manage and monitor GraphDB cluster configurations.

Methods:

Attributes:

Source code in rdflib/contrib/graphdb/client.py 
381
382
def __init__(self, http_client: httpx.Client):
    self._http_client = http_client

http_client property 

http_client

add_nodes 

add_nodes(nodes: list[str]) -> None

Add nodes to the GraphDB cluster.

Parameters:

  • nodes

    (list[str]) –

    List of node addresses to add to the cluster.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
def add_nodes(self, nodes: list[str]) -> None:
    """Add nodes to the GraphDB cluster.

    Parameters:
        nodes: List of node addresses to add to the cluster.

    Raises:
        TypeError: If nodes is not a list of strings.
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        PreconditionFailedError: If one or more nodes in the group are not reachable.
    """
    if not isinstance(nodes, list) or any(
        not isinstance(node, str) for node in nodes
    ):
        raise TypeError("nodes must be a list[str].")

    payload = {"nodes": nodes}
    headers = {"Content-Type": "application/json"}
    try:
        response = self.http_client.post(
            "/rest/cluster/config/node", headers=headers, json=payload
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 412:
            raise PreconditionFailedError(
                f"Precondition failed: {err.response.text}"
            ) from err
        raise

add_tag 

add_tag(tag: str) -> None

Add primary cluster tag.

Parameters:

  • tag

    (str) –

    The identifier tag to add to the primary cluster.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
def add_tag(self, tag: str) -> None:
    """Add primary cluster tag.

    Parameters:
        tag: The identifier tag to add to the primary cluster.

    Raises:
        TypeError: If tag is not a string.
        ValueError: If tag is an empty string.
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        PreconditionFailedError: If the cluster is not in a state to add a tag.
    """
    if not isinstance(tag, str):
        raise TypeError("tag must be a string")
    if not tag:
        raise ValueError("tag must be a non-empty string")

    try:
        response = self.http_client.post(
            "/rest/cluster/config/tag", json={"tag": tag}
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 412:
            raise PreconditionFailedError(
                f"Precondition failed: {err.response.text}"
            ) from err
        raise

create_config 

create_config(nodes: list[str], election_min_timeout: int | None = None, election_range_timeout: int | None = None, heartbeat_interval: int | None = None, message_size_kb: int | None = None, verification_timeout: int | None = None, transaction_log_maximum_size_gb: int | None = None, batch_update_interval: int | None = None) -> None

Create a GraphDB cluster.

Parameters:

  • nodes

    (list[str]) –

    List of node addresses.

  • election_min_timeout

    (int | None, default: None ) –

    The minimum wait time in milliseconds for a heartbeat from a leader.

  • election_range_timeout

    (int | None, default: None ) –

    The variable portion of each waiting period in milliseconds for a heartbeat.

  • heartbeat_interval

    (int | None, default: None ) –

    The interval in milliseconds between each heartbeat that is sent to follower nodes by the leader.

  • message_size_kb

    (int | None, default: None ) –

    The size of the data blocks, in kilobytes, transferred during data replication streaming through the RPC protocol.

  • verification_timeout

    (int | None, default: None ) –

    The amount of time in milliseconds that a follower node would wait before attempting to verify the last committed entry when the first verification is unsuccessful.

  • transaction_log_maximum_size_gb

    (int | None, default: None ) –

    Maximum size of the transaction log in GBs. The transaction log will be automatically truncated if it becomes bigger than this value. The minimum transaction log size is 1 GB. Setting it to a negative value will disable automatic transaction log truncation.

  • batch_update_interval

    (int | None, default: None ) –

    The interval in milliseconds between requesting updates from the primary cluster. Used only when the cluster is in secondary mode.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
def create_config(
    self,
    nodes: list[str],
    election_min_timeout: int | None = None,
    election_range_timeout: int | None = None,
    heartbeat_interval: int | None = None,
    message_size_kb: int | None = None,
    verification_timeout: int | None = None,
    transaction_log_maximum_size_gb: int | None = None,
    batch_update_interval: int | None = None,
) -> None:
    """Create a GraphDB cluster.

    Parameters:
        nodes: List of node addresses.
        election_min_timeout: The minimum wait time in milliseconds for a heartbeat from a leader.
        election_range_timeout: The variable portion of each waiting period in milliseconds for a heartbeat.
        heartbeat_interval: The interval in milliseconds between each heartbeat that is sent to follower nodes by the leader.
        message_size_kb: The size of the data blocks, in kilobytes, transferred during data replication streaming through the RPC protocol.
        verification_timeout: The amount of time in milliseconds that a follower node would wait before attempting to verify the last committed
            entry when the first verification is unsuccessful.
        transaction_log_maximum_size_gb: Maximum size of the transaction log in GBs. The transaction log will be automatically truncated if it
            becomes bigger than this value. The minimum transaction log size is 1 GB. Setting it to a negative value will disable automatic transaction
            log truncation.
        batch_update_interval: The interval in milliseconds between requesting updates from the primary cluster. Used only when the cluster is in
            secondary mode.

    Raises:
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        ConflictError: If the cluster configuration already exists.
        PreconditionFailedError: If the cluster is not in a state to create a configuration.
    """
    try:
        if not isinstance(nodes, list) or any(
            not isinstance(node, str) for node in nodes
        ):
            raise TypeError("nodes must be a list[str].")

        _int_fields: list[tuple[str, int | None]] = [
            ("election_min_timeout", election_min_timeout),
            ("election_range_timeout", election_range_timeout),
            ("heartbeat_interval", heartbeat_interval),
            ("message_size_kb", message_size_kb),
            ("verification_timeout", verification_timeout),
            ("transaction_log_maximum_size_gb", transaction_log_maximum_size_gb),
            ("batch_update_interval", batch_update_interval),
        ]
        for field_name, value in _int_fields:
            if value is not None and type(value) is not int:
                raise TypeError(f"{field_name} must be an int if provided.")

        payload: dict[str, t.Any] = {"nodes": nodes}
        if election_min_timeout is not None:
            payload["electionMinTimeout"] = election_min_timeout
        if election_range_timeout is not None:
            payload["electionRangeTimeout"] = election_range_timeout
        if heartbeat_interval is not None:
            payload["heartbeatInterval"] = heartbeat_interval
        if message_size_kb is not None:
            payload["messageSizeKB"] = message_size_kb
        if verification_timeout is not None:
            payload["verificationTimeout"] = verification_timeout
        if transaction_log_maximum_size_gb is not None:
            payload["transactionLogMaximumSizeGB"] = transaction_log_maximum_size_gb
        if batch_update_interval is not None:
            payload["batchUpdateInterval"] = batch_update_interval

        headers = {"Content-Type": "application/json"}
        response = self.http_client.post(
            "/rest/cluster/config", headers=headers, json=payload
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 409:
            raise ConflictError(
                f"Cluster configuration already exists: {err.response.text}"
            ) from err
        elif status == 412:
            raise PreconditionFailedError(
                f"Precondition failed: {err.response.text}"
            ) from err
        raise

delete_config 

delete_config(force: bool | None = None) -> dict[str, str]

Delete the GraphDB cluster.

By default, the cluster group cannot be deleted if one or more nodes are unreachable. Reachable here means that the nodes are not in status NO_CONNECTION, therefore there is an RPC connection to them.

Parameter

force: When set to True, the cluster configuration will be deleted only on the reachable nodes and the response will always succeed.

Returns:

  • dict[str, str] –

    A dictionary where the node address is the key and the deletion status message is the value.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
def delete_config(self, force: bool | None = None) -> dict[str, str]:
    """Delete the GraphDB cluster.

    By default, the cluster group cannot be deleted if one or more nodes are unreachable.
    Reachable here means that the nodes are not in status `NO_CONNECTION`, therefore there is an
    RPC connection to them.

    Parameter:
        force: When set to `True`, the cluster configuration will be deleted only on the reachable nodes and
            the response will always succeed.

    Returns:
        A dictionary where the node address is the key and the deletion status message is the value.

    Raises:
        ResponseFormatError: If the response is not in the expected format.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        PreconditionFailedError: If one or more nodes in the group are not reachable and force is not set to `True`.
    """
    params: dict[str, str] | None = None
    if force is not None:
        params = {"force": str(force).lower()}
    try:
        headers = {"Accept": "application/json"}
        if params is None:
            response = self.http_client.delete(
                "/rest/cluster/config", headers=headers
            )
        else:
            response = self.http_client.delete(
                "/rest/cluster/config", headers=headers, params=params
            )
        response.raise_for_status()
        try:
            payload = response.json()
        except (ValueError, TypeError) as err:
            raise ResponseFormatError(
                f"Failed to parse cluster deletion response: {err}"
            ) from err
        if not isinstance(payload, dict):
            raise ResponseFormatError(
                "Failed to parse cluster deletion response: expected a JSON object."
            )
        if not all(
            isinstance(key, str) and isinstance(value, str)
            for key, value in payload.items()
        ):
            raise ResponseFormatError(
                "Failed to parse cluster deletion response: expected string keys and values."
            )
        return t.cast(dict[str, str], payload)
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 412:
            raise PreconditionFailedError(
                f"Precondition failed: {err.response.text}"
            ) from err
        raise

delete_tag 

delete_tag(tag: str) -> None

Remove primary cluster tag.

Parameters:

  • tag

    (str) –

    The identifier tag to remove from the primary cluster.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
def delete_tag(self, tag: str) -> None:
    """Remove primary cluster tag.

    Parameters:
        tag: The identifier tag to remove from the primary cluster.

    Raises:
        TypeError: If tag is not a string.
        ValueError: If tag is an empty string.
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        PreconditionFailedError: If the cluster is not in a state to delete a tag.
    """
    if not isinstance(tag, str):
        raise TypeError("tag must be a string")
    if not tag:
        raise ValueError("tag must be a non-empty string")

    headers = {"Content-Type": "application/json"}
    try:
        response = self.http_client.request(
            method="DELETE",
            url="/rest/cluster/config/tag",
            headers=headers,
            json={"tag": tag},
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 412:
            raise PreconditionFailedError(
                f"Precondition failed: {err.response.text}"
            ) from err
        raise

disable_secondary_mode 

disable_secondary_mode() -> None

Disable cluster secondary mode.

Once in secondary mode, you can disable secondary mode and then you will no longer be in that mode. Doing this will stop the pulling of updates from the primary cluster.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
def disable_secondary_mode(self) -> None:
    """Disable cluster secondary mode.

    Once in secondary mode, you can disable secondary mode and then you will no longer be in
    that mode. Doing this will stop the pulling of updates from the primary cluster.

    Raises:
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        PreconditionFailedError: If the cluster is not in a state to disable secondary mode.
    """
    try:
        response = self.http_client.delete("/rest/cluster/config/secondary-mode")
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 412:
            raise PreconditionFailedError(
                f"Precondition failed: {err.response.text}"
            ) from err
        raise

enable_secondary_mode 

enable_secondary_mode(primary_node: str, tag: str) -> None

Enable cluster secondary mode.

You can switch any healthy primary cluster to secondary mode by providing the RPC address of the primary cluster node that it will replicate and then declaring the tag used to identify it. Once you have switched a cluster to secondary mode, all of its current repositories and data will be removed and replaced with the data and state of the primary cluster.

Note

You can enable the secondary cluster mode from any of the nodes of a cluster, not just the leader node. You can also use any of the healthy nodes of the primary cluster to connect to that cluster.

Warning

Enabling the secondary mode will delete all data on the secondary cluster and replicate the state of the primary cluster.

Parameters:

  • primary_node

    (str) –

    The RPC address of one of the healthy nodes of the primary cluster.

  • tag

    (str) –

    The identifier tag of the primary cluster.

Raises:

  • TypeError –

    If primary_node or tag is not a string.

  • ValueError –

    If primary_node or tag is an empty string.

  • BadRequestError –

    If the request is invalid.

  • UnauthorisedError –

    If the request is unauthorised.

  • ForbiddenError –

    If the request is forbidden.

  • PreconditionFailedError –

    If the cluster is not in a state to enable secondary mode.

Source code in rdflib/contrib/graphdb/client.py 
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
def enable_secondary_mode(self, primary_node: str, tag: str) -> None:
    """Enable cluster secondary mode.

    You can switch any healthy primary cluster to secondary mode by providing the RPC address
    of the primary cluster node that it will replicate and then declaring the tag used to identify
    it. Once you have switched a cluster to secondary mode, all of its current repositories and
    data will be removed and replaced with the data and state of the primary cluster.

    !!! Note
        You can enable the secondary cluster mode from any of the nodes of a cluster, not just the
        leader node. You can also use any of the healthy nodes of the primary cluster to connect to
        that cluster.

    !!! Warning
        Enabling the secondary mode will delete all data on the secondary cluster and replicate
        the state of the primary cluster.

    Parameters:
        primary_node: The RPC address of one of the healthy nodes of the primary cluster.
        tag: The identifier tag of the primary cluster.

    Raises:
        TypeError: If primary_node or tag is not a string.
        ValueError: If primary_node or tag is an empty string.
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        PreconditionFailedError: If the cluster is not in a state to enable secondary mode.
    """
    if not isinstance(primary_node, str):
        raise TypeError("primary_node must be a string")
    if not primary_node:
        raise ValueError("primary_node must be a non-empty string")
    if not isinstance(tag, str):
        raise TypeError("tag must be a string")
    if not tag:
        raise ValueError("tag must be a non-empty string")

    payload = {"primaryNode": primary_node, "tag": tag}
    try:
        response = self.http_client.post(
            "/rest/cluster/config/secondary-mode", json=payload
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 412:
            raise PreconditionFailedError(
                f"Precondition failed: {err.response.text}"
            ) from err
        raise

get_config 

get_config() -> ClusterRequest

Get the GraphDB cluster configuration.

Returns:

Raises:

Source code in rdflib/contrib/graphdb/client.py 
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
def get_config(self) -> ClusterRequest:
    """Get the GraphDB cluster configuration.

    Returns:
        Cluster configuration.

    Raises:
        ResponseFormatError: If the response is not in the expected format.
        UnauthorisedError: If the request is unauthorised.
        NotFoundError: If the cluster configuration is not found.
        InternalServerError: If the server returns an internal error.
    """
    try:
        headers = {"Accept": "application/json"}
        response = self.http_client.get("/rest/cluster/config", headers=headers)
        response.raise_for_status()
        try:
            return ClusterRequest.from_dict(response.json())
        except (KeyError, TypeError, ValueError) as err:
            raise ResponseFormatError(
                f"Failed to parse cluster configuration: {err}"
            ) from err
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 404:
            raise NotFoundError(
                f"Cluster configuration not found: {err.response.text}"
            ) from err
        elif status == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

group_status 

group_status() -> list[NodeStatus]

Get the status of the GraphDB cluster.

Returns:

  • list[NodeStatus] –

    A list of node statuses for the cluster group.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
def group_status(self) -> list[NodeStatus]:
    """Get the status of the GraphDB cluster.

    Returns:
        A list of node statuses for the cluster group.

    Raises:
        ResponseFormatError: If the response cannot be parsed.
        BadRequestError: If the request is invalid.
        NotFoundError: If the group status is not found.
        InternalServerError: If the internal server error.
    """
    try:
        headers = {"Accept": "application/json"}
        response = self.http_client.get(
            "/rest/cluster/group/status", headers=headers
        )
        response.raise_for_status()
        try:
            data = response.json()
            return [NodeStatus.from_dict(item) for item in data]
        except (KeyError, TypeError, ValueError) as err:
            raise ResponseFormatError(
                f"Failed to parse group status: {err}"
            ) from err
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 404:
            raise NotFoundError(
                f"Group status not found: {err.response.text}"
            ) from err
        elif status == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

node_status 

node_status() -> NodeStatus

Get the status of this GraphDB cluster node.

Returns:

  • NodeStatus ( NodeStatus ) –

    The status of this GraphDB cluster node.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
def node_status(self) -> NodeStatus:
    """Get the status of this GraphDB cluster node.

    Returns:
        NodeStatus: The status of this GraphDB cluster node.

    Raises:
        ResponseFormatError: If the response cannot be parsed.
        BadRequestError: If the request is invalid.
        NotFoundError: If the node status is not found.
        InternalServerError: If the internal server error.
    """
    try:
        headers = {"Accept": "application/json"}
        response = self.http_client.get(
            "/rest/cluster/node/status", headers=headers
        )
        response.raise_for_status()
        try:
            return NodeStatus.from_dict(response.json())
        except (KeyError, TypeError, ValueError) as err:
            raise ResponseFormatError(
                f"Failed to parse node status: {err}"
            ) from err
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 404:
            raise NotFoundError(
                f"Node status not found: {err.response.text}"
            ) from err
        elif status == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

remove_nodes 

remove_nodes(nodes: list[str]) -> None

Remove nodes from the GraphDB cluster.

Parameters:

  • nodes

    (list[str]) –

    List of node addresses to remove from the cluster.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
def remove_nodes(self, nodes: list[str]) -> None:
    """Remove nodes from the GraphDB cluster.

    Parameters:
        nodes: List of node addresses to remove from the cluster.

    Raises:
        TypeError: If nodes is not a list of strings.
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        PreconditionFailedError: If one or more nodes in the group are not reachable.
    """
    if not isinstance(nodes, list) or any(
        not isinstance(node, str) for node in nodes
    ):
        raise TypeError("nodes must be a list[str].")

    payload = {"nodes": nodes}
    try:
        response = self.http_client.request(
            method="DELETE",
            url="/rest/cluster/config/node",
            json=payload,
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 412:
            raise PreconditionFailedError(
                f"Precondition failed: {err.response.text}"
            ) from err
        raise

replace_nodes 

replace_nodes(add_nodes: list[str], remove_nodes: list[str]) -> None

Replace nodes in the GraphDB cluster.

Parameters:

  • add_nodes

    (list[str]) –

    List of node addresses to add to the cluster.

  • remove_nodes

    (list[str]) –

    List of node addresses to remove from the cluster.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
def replace_nodes(self, add_nodes: list[str], remove_nodes: list[str]) -> None:
    """Replace nodes in the GraphDB cluster.

    Parameters:
        add_nodes: List of node addresses to add to the cluster.
        remove_nodes: List of node addresses to remove from the cluster.

    Raises:
        TypeError: If add_nodes or remove_nodes is not a list of strings.
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        PreconditionFailedError: If one or more nodes in the group are not reachable.
    """
    if not isinstance(add_nodes, list) or any(
        not isinstance(node, str) for node in add_nodes
    ):
        raise TypeError("add_nodes must be a list[str].")
    if not isinstance(remove_nodes, list) or any(
        not isinstance(node, str) for node in remove_nodes
    ):
        raise TypeError("remove_nodes must be a list[str].")

    payload = {"removeNodes": remove_nodes, "addNodes": add_nodes}
    try:
        response = self.http_client.patch("/rest/cluster/config/node", json=payload)
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 412:
            raise PreconditionFailedError(
                f"Precondition failed: {err.response.text}"
            ) from err
        raise

truncate_log 

truncate_log() -> None

Truncate the GraphDB cluster log.

The truncate log operation is used to free up storage space on all cluster nodes by clearing the current transaction log and removing cached recovery snapshots.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
def truncate_log(self) -> None:
    """Truncate the GraphDB cluster log.

    The truncate log operation is used to free up storage space on all cluster nodes by clearing the
    current transaction log and removing cached recovery snapshots.

    Raises:
        ResponseFormatError: If the response is not in the expected format.
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
    """
    try:
        response = self.http_client.post("/rest/cluster/truncate-log")
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        raise

update_config 

update_config(election_min_timeout: int | None = None, election_range_timeout: int | None = None, heartbeat_interval: int | None = None, message_size_kb: int | None = None, verification_timeout: int | None = None, transaction_log_maximum_size_gb: int | None = None, batch_update_interval: int | None = None) -> ClusterRequest

Update the GraphDB cluster configuration.

If one of the cluster nodes is down or was not able to accept the new configuration, the operation will not be successful. A total consensus between the nodes is required. In case one or more of them cannot append the new configuration, it will be rejected by all of the nodes.

Parameters:

  • election_min_timeout

    (int | None, default: None ) –

    The minimum wait time in milliseconds for a heartbeat from a leader.

  • election_range_timeout

    (int | None, default: None ) –

    The variable portion of each waiting period in milliseconds for a heartbeat.

  • heartbeat_interval

    (int | None, default: None ) –

    The interval in milliseconds between each heartbeat that is sent to follower nodes by the leader.

  • message_size_kb

    (int | None, default: None ) –

    The size of the data blocks, in kilobytes, transferred during data replication streaming through the RPC protocol.

  • verification_timeout

    (int | None, default: None ) –

    The amount of time in milliseconds that a follower node would wait before attempting to verify the last committed entry when the first verification is unsuccessful.

  • transaction_log_maximum_size_gb

    (int | None, default: None ) –

    Maximum size of the transaction log in GBs. The transaction log will be automatically truncated if it becomes bigger than this value. The minimum transaction log size is 1 GB. Setting it to a negative value will disable automatic transaction log truncation.

  • batch_update_interval

    (int | None, default: None ) –

    The interval in milliseconds between requesting updates from the primary cluster. Used only when the cluster is in secondary mode.

Returns:

Raises:

Source code in rdflib/contrib/graphdb/client.py 
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
def update_config(
    self,
    election_min_timeout: int | None = None,
    election_range_timeout: int | None = None,
    heartbeat_interval: int | None = None,
    message_size_kb: int | None = None,
    verification_timeout: int | None = None,
    transaction_log_maximum_size_gb: int | None = None,
    batch_update_interval: int | None = None,
) -> ClusterRequest:
    """Update the GraphDB cluster configuration.

    If one of the cluster nodes is down or was not able to accept the new configuration,
    the operation will not be successful. A total consensus between the nodes is required.
    In case one or more of them cannot append the new configuration, it will be rejected
    by all of the nodes.

    Parameters:
        election_min_timeout: The minimum wait time in milliseconds for a heartbeat from a leader.
        election_range_timeout: The variable portion of each waiting period in milliseconds for a heartbeat.
        heartbeat_interval: The interval in milliseconds between each heartbeat that is sent to follower nodes by the leader.
        message_size_kb: The size of the data blocks, in kilobytes, transferred during data replication streaming through the RPC protocol.
        verification_timeout: The amount of time in milliseconds that a follower node would wait before attempting to verify the last committed
            entry when the first verification is unsuccessful.
        transaction_log_maximum_size_gb: Maximum size of the transaction log in GBs. The transaction log will be automatically truncated if it
            becomes bigger than this value. The minimum transaction log size is 1 GB. Setting it to a negative value will disable automatic transaction
            log truncation.
        batch_update_interval: The interval in milliseconds between requesting updates from the primary cluster. Used only when the cluster is in
            secondary mode.

    Returns:
        The updated cluster configuration.

    Raises:
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        PreconditionFailedError: If one or more nodes in the group are not reachable.
    """
    _int_fields: list[tuple[str, int | None]] = [
        ("election_min_timeout", election_min_timeout),
        ("election_range_timeout", election_range_timeout),
        ("heartbeat_interval", heartbeat_interval),
        ("message_size_kb", message_size_kb),
        ("verification_timeout", verification_timeout),
        ("transaction_log_maximum_size_gb", transaction_log_maximum_size_gb),
        ("batch_update_interval", batch_update_interval),
    ]
    for field_name, value in _int_fields:
        if value is not None and type(value) is not int:
            raise TypeError(f"{field_name} must be an int if provided.")

    payload: dict[str, t.Any] = {}
    if election_min_timeout is not None:
        payload["electionMinTimeout"] = election_min_timeout
    if election_range_timeout is not None:
        payload["electionRangeTimeout"] = election_range_timeout
    if heartbeat_interval is not None:
        payload["heartbeatInterval"] = heartbeat_interval
    if message_size_kb is not None:
        payload["messageSizeKB"] = message_size_kb
    if verification_timeout is not None:
        payload["verificationTimeout"] = verification_timeout
    if transaction_log_maximum_size_gb is not None:
        payload["transactionLogMaximumSizeGB"] = transaction_log_maximum_size_gb
    if batch_update_interval is not None:
        payload["batchUpdateInterval"] = batch_update_interval

    headers = {"Accept": "application/json"}
    try:
        response = self.http_client.patch(
            "/rest/cluster/config", headers=headers, json=payload
        )
        response.raise_for_status()
        try:
            return ClusterRequest.from_dict(response.json())
        except (KeyError, TypeError, ValueError) as err:
            raise ResponseFormatError(
                f"Failed to parse updated cluster configuration: {err}"
            ) from err
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 412:
            raise PreconditionFailedError(
                f"Precondition failed: {err.response.text}"
            ) from err
        raise

GraphDBClient 

GraphDBClient(base_url: str, auth: tuple[str, str] | str | None = None, timeout: float | Timeout = 30.0, **kwargs: Any)

Bases: RDF4JClient

GraphDB Client

This client and its inner management objects perform HTTP requests via httpx and may raise httpx-specific exceptions. Errors documented by GraphDB in its OpenAPI specification are mapped to specific exceptions in this library where applicable. Error mappings are documented on each management method. The underlying httpx client is reused across requests, and connection pooling is handled automatically by httpx.

Parameters:

  • base_url

    (str) –

    The base URL of the GraphDB server.

  • auth

    (tuple[str, str] | str | None, default: None ) –

    Authentication credentials. Can be a tuple (username, password) for basic auth, or a string for token-based auth (e.g., “GDB “) which is added as the Authorization header.

  • timeout

    (float | Timeout, default: 30.0 ) –

    Request timeout in seconds or an httpx.Timeout for fine-grained control (default: 30.0).

  • kwargs

    (Any, default: {} ) –

    Additional keyword arguments to pass to the httpx.Client.

Methods:

  • login –

    Authenticate with GraphDB and obtain a GDB token.

Attributes:

Source code in rdflib/contrib/graphdb/client.py 
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
def __init__(
    self,
    base_url: str,
    auth: tuple[str, str] | str | None = None,
    timeout: float | httpx.Timeout = 30.0,
    **kwargs: t.Any,
):
    super().__init__(base_url, auth, timeout, **kwargs)
    self._cluster_group = ClusterGroupManagement(self.http_client)
    self._monitoring = MonitoringManagement(self.http_client)
    self._recovery = RecoveryManagement(self.http_client)
    self._graphdb_repository_manager = RepositoryManager(self.http_client)
    self._graphdb_repositories = RepositoryManagement(self.http_client)
    self._security = SecurityManagement(self.http_client)
    self._users = UserManagement(self.http_client)

cluster property 

cluster: ClusterGroupManagement

graphdb_repositories property 

graphdb_repositories: RepositoryManagement

monitoring property 

monitoring: MonitoringManagement

recovery property 

recovery: RecoveryManagement

repositories property 

repositories: RepositoryManager

Server-level repository management operations (GraphDB-specific).

security property 

security: SecurityManagement

users property 

users: UserManagement

login 

login(username: str, password: str) -> AuthenticatedUser

Authenticate with GraphDB and obtain a GDB token.

Parameters:

  • username

    (str) –

    The username to authenticate with.

  • password

    (str) –

    The password to authenticate with.

Returns:

  • AuthenticatedUser –

    An AuthenticatedUser instance containing user details and the GDB token.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
def login(self, username: str, password: str) -> AuthenticatedUser:
    """Authenticate with GraphDB and obtain a GDB token.

    Parameters:
        username: The username to authenticate with.
        password: The password to authenticate with.

    Returns:
        An AuthenticatedUser instance containing user details and the GDB token.

    Raises:
        UnauthorisedError: If the credentials are invalid.
        BadRequestError: If the request body is invalid.
        ResponseFormatError: If the response cannot be parsed.
    """
    try:
        response = self.http_client.post(
            "/rest/login",
            json={"username": username, "password": password},
        )
        response.raise_for_status()

        auth_header = response.headers.get("Authorization", "")
        if not auth_header.startswith("GDB "):
            raise ResponseFormatError(
                "Authorization header missing or invalid format"
            )

        try:
            data = response.json()
        except (ValueError, TypeError) as err:
            raise ResponseFormatError(
                f"Failed to parse login response: {err}"
            ) from err

        try:
            return AuthenticatedUser.from_response(data, auth_header)
        except (ValueError, TypeError) as err:
            raise ResponseFormatError(
                f"Failed to parse authenticated user: {err}"
            ) from err

    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Invalid credentials: {err.response.text}"
            ) from err
        raise

MonitoringManagement 

MonitoringManagement(http_client: Client)

Monitor different GraphDB processes.

Methods:

Attributes:

Source code in rdflib/contrib/graphdb/client.py 
1312
1313
def __init__(self, http_client: httpx.Client):
    self._http_client = http_client

http_client property 

http_client

infrastructure property 

infrastructure: InfrastructureStatistics

Get all infrastructure statistics.

Returns:

Raises:

structures property 

structures: StructuresStatistics

Get structures statistics.

Returns:

Raises:

backup 

backup() -> BackupOperationBean | None

Track backup operations.

Returns:

  • BackupOperationBean | None –

    On-going backup operations or None if no backup is in progress.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
def backup(self) -> BackupOperationBean | None:
    """Track backup operations.

    Returns:
        On-going backup operations or `None` if no backup is in progress.

    Raises:
        ResponseFormatError: If the response cannot be parsed.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        InternalServerError: If the server returns an internal error.
        ServiceUnavailableError: If the server is unavailable.
    """
    try:
        headers = {"Accept": "application/json"}
        response = self.http_client.get("/rest/monitor/backup", headers=headers)
        response.raise_for_status()
        try:
            data = response.json()
            if not data:
                return None
            return BackupOperationBean.from_dict(data)
        except (ValueError, TypeError, KeyError) as err:
            raise ResponseFormatError(f"Failed to parse response: {err}") from err
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        elif status == 503:
            raise ServiceUnavailableError(
                f"Service is unavailable: {err.response.text}"
            ) from err
        raise

cluster 

cluster() -> str

Get cluster statistics.

Note

This endpoint is only available in GraphDB EE.

Returns:

  • str –

    Prometheus-style metrics.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
def cluster(self) -> str:
    """Get cluster statistics.

    !!! Note
        This endpoint is only available in GraphDB EE.

    Returns:
        Prometheus-style metrics.

    Raises:
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        InternalServerError: If the server returns an internal error.
        ServiceUnavailableError: If the server is unavailable.
    """
    try:
        headers = {"Accept": "text/plain"}
        response = self.http_client.get("/rest/monitor/cluster", headers=headers)
        response.raise_for_status()
        return response.text
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        elif status == 503:
            raise ServiceUnavailableError(
                f"Service is unavailable: {err.response.text}"
            ) from err
        raise

get_repo_stats 

get_repo_stats(repository_id: str)

Get repository statistics.

Parameters:

  • repository_id

    (str) –

    The identifier of the repository.

Returns:

  • RepositoryStatistics –

    The repository statistics.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
def get_repo_stats(self, repository_id: str):
    """Get repository statistics.

    Parameters:
        repository_id: The identifier of the repository.

    Returns:
        RepositoryStatistics: The repository statistics.

    Raises:
        ResponseFormatError: If the response cannot be parsed.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        InternalServerError: If the server returns an internal error.
    """
    try:
        headers = {"Accept": "application/json"}
        response = self.http_client.get(
            f"/rest/monitor/repository/{repository_id}", headers=headers
        )
        response.raise_for_status()
        try:
            return RepositoryStatistics.from_dict(response.json())
        except (ValueError, TypeError, KeyError) as err:
            raise ResponseFormatError(f"Failed to parse response: {err}") from err
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

RecoveryManagement 

RecoveryManagement(http_client: Client)

GraphDB Recovery Management client.

Methods:

  • backup –

    Create a new backup of GraphDB instance.

  • cloud_backup –

    Create a new backup of GraphDB instance uploaded to a cloud bucket.

  • cloud_restore –

    Restore GraphDB instance from a cloud backup archive.

  • restore –

    Restore GraphDB instance from a backup archive.

Attributes:

Source code in rdflib/contrib/graphdb/client.py 
1531
1532
def __init__(self, http_client: httpx.Client):
    self._http_client = http_client

http_client property 

http_client

backup 

backup(repositories: list[str] | None = None, backup_system_data: bool | None = None, *, dest: None = None) -> bytes

backup(repositories: list[str] | None = None, backup_system_data: bool | None = None, *, dest: str | PathLike[str]) -> Path

backup(repositories: list[str] | None = None, backup_system_data: bool | None = None, *, dest: str | PathLike[str] | None = None) -> bytes | Path

Create a new backup of GraphDB instance.

The backup is returned as a tar archive containing repository data and optionally system data (user accounts, saved queries, visual graphs, etc.).

Parameters:

  • repositories

    (list[str] | None, default: None ) –

    List of repositories to be backed up, specified by their repository identifiers. If None, all repositories will be included in the backup.

  • backup_system_data

    (bool | None, default: None ) –

    Determines whether user account data such as user accounts, saved queries, or visual graphs, among others, should be included in the backup.

  • dest

    (str | PathLike[str] | None, default: None ) –

    Destination path to save the backup archive. If None, the backup content is returned as bytes (suitable for small backups). If a directory path is provided, the filename from the response Content-Disposition header is used (e.g., backup-2026-01-16-10-30-00.tar). If a file path is provided, that exact path is used. The response is streamed directly to disk (recommended for large backups).

Returns:

  • bytes ( bytes | Path ) –

    If dest is None, returns the backup archive as bytes.

  • Path ( bytes | Path ) –

    If dest is provided, returns the resolved pathlib.Path where the backup was saved.

Raises:

  • ValueError –

    If repositories is not a list or None, or if backup_system_data is not a bool or None.

  • BadRequestError –

    If the request is bad.

  • UnauthorisedError –

    If the request is unauthorised.

  • ForbiddenError –

    If the request is forbidden.

  • OSError –

    If the destination path cannot be written to.

Source code in rdflib/contrib/graphdb/client.py 
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
def backup(
    self,
    repositories: list[str] | None = None,
    backup_system_data: bool | None = None,
    *,
    dest: str | os.PathLike[str] | None = None,
) -> bytes | pathlib.Path:
    """Create a new backup of GraphDB instance.

    The backup is returned as a tar archive containing repository data and
    optionally system data (user accounts, saved queries, visual graphs, etc.).

    Parameters:
        repositories: List of repositories to be backed up, specified by their repository identifiers.
            If `None`, all repositories will be included in the backup.
        backup_system_data: Determines whether user account data such as user accounts, saved queries,
            or visual graphs, among others, should be included in the backup.
        dest: Destination path to save the backup archive. If `None`, the backup
            content is returned as bytes (suitable for small backups). If a directory
            path is provided, the filename from the response Content-Disposition header
            is used (e.g., backup-2026-01-16-10-30-00.tar). If a file path is provided,
            that exact path is used. The response is streamed directly to disk
            (recommended for large backups).

    Returns:
        bytes: If `dest` is `None`, returns the backup archive as bytes.
        Path: If `dest` is provided, returns the resolved `pathlib.Path` where the backup was saved.

    Raises:
        ValueError: If repositories is not a list or None, or if backup_system_data is not a bool or None.
        BadRequestError: If the request is bad.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        OSError: If the destination path cannot be written to.
    """
    if repositories is not None:
        if not isinstance(repositories, list):
            raise ValueError("repositories must be a list or None")
        if not all(isinstance(r, str) for r in repositories):
            raise ValueError("repositories must be a list of strings")
    if not isinstance(backup_system_data, bool) and backup_system_data is not None:
        raise ValueError("backup_system_data must be a bool")

    payload: dict[str, t.Any] = {}
    if repositories is not None:
        payload["repositories"] = repositories
    if backup_system_data is not None:
        payload["backupSystemData"] = backup_system_data

    def _handle_http_error(err: httpx.HTTPStatusError) -> t.NoReturn:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Bad request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        raise err

    if dest is None:
        # Return bytes directly (suitable for small backups)
        try:
            response = self.http_client.post("/rest/recovery/backup", json=payload)
            response.raise_for_status()
            return response.content
        except httpx.HTTPStatusError as err:
            _handle_http_error(err)
    else:
        # Stream to disk (recommended for large backups)
        dest_path = pathlib.Path(dest).expanduser().resolve()

        try:
            with self.http_client.stream(
                "POST", "/rest/recovery/backup", json=payload
            ) as response:
                response.raise_for_status()

                # If dest is a directory, extract filename from Content-Disposition
                if dest_path.is_dir():
                    content_disposition = response.headers.get(
                        "Content-Disposition", ""
                    )
                    filename = extract_filename_from_content_disposition(
                        content_disposition
                    )
                    if filename:
                        dest_path = dest_path / filename
                    else:
                        # Fallback to a default name if header parsing fails
                        dest_path = dest_path / "graphdb-backup.tar"

                # Use a temporary file during download, then rename atomically
                tmp_path = dest_path.with_suffix(dest_path.suffix + ".partial")

                with open(tmp_path, "wb") as f:
                    for chunk in response.iter_bytes():
                        f.write(chunk)
                tmp_path.replace(dest_path)
            return dest_path
        except httpx.HTTPStatusError as err:
            _handle_http_error(err)

cloud_backup 

cloud_backup(bucket_uri: str, repositories: list[str] | None = None, backup_system_data: bool | None = None, authentication_file: bytes | bytearray | memoryview | IO[bytes] | str | PathLike[str] | None = None) -> None

Create a new backup of GraphDB instance uploaded to a cloud bucket.

GraphDB uploads the resulting .tar archive directly to the configured cloud bucket. This uses the GraphDB endpoint /rest/recovery/cloud-backup.

Parameters:

  • bucket_uri

    (str) –

    Cloud bucket URI including provider-specific parameters (required).

  • repositories

    (list[str] | None, default: None ) –

    Optional list of repositories to be backed up.

  • backup_system_data

    (bool | None, default: None ) –

    Optional flag to include system data (users, saved queries, etc.).

  • authentication_file

    (bytes | bytearray | memoryview | IO[bytes] | str | PathLike[str] | None, default: None ) –

    Optional credential file content as bytes/bytes-like, a binary file-like object, or a filesystem path.

Raises:

  • ValueError –

    If parameters are invalid, or authentication_file is not a supported type.

  • BadRequestError –

    If the request is bad.

  • UnauthorisedError –

    If the request is unauthorised.

  • ForbiddenError –

    If the request is forbidden.

Source code in rdflib/contrib/graphdb/client.py 
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
def cloud_backup(
    self,
    bucket_uri: str,
    repositories: list[str] | None = None,
    backup_system_data: bool | None = None,
    authentication_file: (
        bytes | bytearray | memoryview | t.IO[bytes] | str | os.PathLike[str] | None
    ) = None,
) -> None:
    """Create a new backup of GraphDB instance uploaded to a cloud bucket.

    GraphDB uploads the resulting `.tar` archive directly to the configured
    cloud bucket. This uses the GraphDB endpoint `/rest/recovery/cloud-backup`.

    Parameters:
        bucket_uri: Cloud bucket URI including provider-specific parameters (required).
        repositories: Optional list of repositories to be backed up.
        backup_system_data: Optional flag to include system data (users, saved queries, etc.).
        authentication_file: Optional credential file content as bytes/bytes-like, a
            binary file-like object, or a filesystem path.

    Raises:
        ValueError: If parameters are invalid, or authentication_file is not a supported type.
        BadRequestError: If the request is bad.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
    """
    if not isinstance(bucket_uri, str) or not bucket_uri:
        raise ValueError("bucket_uri must be a non-empty string")

    if repositories is not None:
        if not isinstance(repositories, list):
            raise ValueError("repositories must be a list or None")
        if not all(isinstance(r, str) for r in repositories):
            raise ValueError("repositories must be a list of strings")

    if not isinstance(backup_system_data, bool) and backup_system_data is not None:
        raise ValueError("backup_system_data must be a bool")

    payload: dict[str, t.Any] = {}
    if repositories is not None:
        payload["repositories"] = repositories
    if backup_system_data is not None:
        payload["backupSystemData"] = backup_system_data
    payload["bucketUri"] = bucket_uri

    params_part: FileContent = (None, json.dumps(payload), "application/json")

    def _post(authentication_part: FileContent | None) -> None:
        files: list[tuple[str, FileContent]] = [("params", params_part)]
        if authentication_part is not None:
            files.append(("authenticationFile", authentication_part))
        try:
            response = self.http_client.post(
                "/rest/recovery/cloud-backup",
                headers={"Accept": "application/json"},
                files=files,
            )
            response.raise_for_status()
        except httpx.HTTPStatusError as err:
            status = err.response.status_code
            if status == 400:
                raise BadRequestError(f"Bad request: {err.response.text}") from err
            elif status == 401:
                raise UnauthorisedError(
                    f"Request is unauthorised: {err.response.text}"
                ) from err
            elif status == 403:
                raise ForbiddenError(
                    f"Request is forbidden: {err.response.text}"
                ) from err
            raise err

    if authentication_file is None:
        _post(None)
        return

    if isinstance(authentication_file, (bytes, bytearray, memoryview)):
        content = bytes(authentication_file)
        _post(("authentication-file", content, "application/octet-stream"))
        return

    if hasattr(authentication_file, "read") and not isinstance(
        authentication_file, (str, os.PathLike)
    ):
        file_obj = t.cast(t.IO[bytes], authentication_file)
        filename = infer_filename_from_fileobj(file_obj, "authentication-file")
        _post((filename, file_obj, "application/octet-stream"))
        return

    if isinstance(authentication_file, (str, os.PathLike)):
        auth_path = pathlib.Path(authentication_file).expanduser()
        with open(auth_path, "rb") as f:
            filename = auth_path.name or infer_filename_from_fileobj(
                f, "authentication-file"
            )
            _post((filename, f, "application/octet-stream"))
        return

    raise ValueError(
        "authentication_file must be bytes/bytes-like, a binary file-like object, or a filesystem path"
    )

cloud_restore 

cloud_restore(bucket_uri: str, repositories: list[str] | None = None, restore_system_data: bool | None = None, remove_stale_repositories: bool | None = None, authentication_file: bytes | bytearray | memoryview | IO[bytes] | str | PathLike[str] | None = None) -> None

Restore GraphDB instance from a cloud backup archive.

Parameters:

  • bucket_uri

    (str) –

    Cloud bucket URI including provider-specific parameters (required).

  • repositories

    (list[str] | None, default: None ) –

    List of repositories to restore. If None (default), the parameter is omitted and all repositories found in the backup are restored. If an empty list ([]) is provided, no repositories from the backup are restored.

  • restore_system_data

    (bool | None, default: None ) –

    Whether to restore system data (users, saved queries, visual graphs, etc.). If omitted, GraphDB defaults to false. If true and no system data exists in the backup, GraphDB returns an error.

  • remove_stale_repositories

    (bool | None, default: None ) –

    Whether to remove repositories on the target instance that are not restored from the backup. If omitted, GraphDB defaults to false.

  • authentication_file

    (bytes | bytearray | memoryview | IO[bytes] | str | PathLike[str] | None, default: None ) –

    Optional credential file content as bytes/bytes-like, a binary file-like object, or a filesystem path.

Raises:

  • ValueError –

    If parameters are invalid, or authentication_file is not a supported type.

  • BadRequestError –

    If the request is bad.

  • UnauthorisedError –

    If the request is unauthorised.

  • ForbiddenError –

    If the request is forbidden.

Source code in rdflib/contrib/graphdb/client.py 
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
def cloud_restore(
    self,
    bucket_uri: str,
    repositories: list[str] | None = None,
    restore_system_data: bool | None = None,
    remove_stale_repositories: bool | None = None,
    authentication_file: (
        bytes | bytearray | memoryview | t.IO[bytes] | str | os.PathLike[str] | None
    ) = None,
) -> None:
    """Restore GraphDB instance from a cloud backup archive.

    Parameters:
        bucket_uri: Cloud bucket URI including provider-specific parameters (required).
        repositories: List of repositories to restore. If `None` (default), the
            parameter is omitted and all repositories found in the backup are
            restored. If an empty list (`[]`) is provided, no repositories from
            the backup are restored.
        restore_system_data: Whether to restore system data (users, saved queries,
            visual graphs, etc.). If omitted, GraphDB defaults to `false`. If
            `true` and no system data exists in the backup, GraphDB returns an
            error.
        remove_stale_repositories: Whether to remove repositories on the target
            instance that are not restored from the backup. If omitted, GraphDB
            defaults to `false`.
        authentication_file: Optional credential file content as bytes/bytes-like, a
            binary file-like object, or a filesystem path.

    Raises:
        ValueError: If parameters are invalid, or authentication_file is not a supported type.
        BadRequestError: If the request is bad.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
    """
    if not isinstance(bucket_uri, str) or not bucket_uri:
        raise ValueError("bucket_uri must be a non-empty string")

    if repositories is not None:
        if not isinstance(repositories, list):
            raise ValueError("repositories must be a list or None")
        if not all(isinstance(r, str) for r in repositories):
            raise ValueError("repositories must be a list of strings")
    if (
        not isinstance(restore_system_data, bool)
        and restore_system_data is not None
    ):
        raise ValueError("restore_system_data must be a bool or None")
    if (
        not isinstance(remove_stale_repositories, bool)
        and remove_stale_repositories is not None
    ):
        raise ValueError("remove_stale_repositories must be a bool or None")

    payload: dict[str, t.Any] = {}
    if repositories is not None:
        payload["repositories"] = repositories
    if restore_system_data is not None:
        payload["restoreSystemData"] = restore_system_data
    if remove_stale_repositories is not None:
        payload["removeStaleRepositories"] = remove_stale_repositories
    payload["bucketUri"] = bucket_uri

    params_part: FileContent = (None, json.dumps(payload), "application/json")

    def _post(authentication_part: FileContent | None) -> None:
        files: list[tuple[str, FileContent]] = [("params", params_part)]
        if authentication_part is not None:
            files.append(("authenticationFile", authentication_part))
        try:
            response = self.http_client.post(
                "/rest/recovery/cloud-restore",
                headers={"Accept": "application/json"},
                files=files,
            )
            response.raise_for_status()
        except httpx.HTTPStatusError as err:
            status = err.response.status_code
            if status == 400:
                raise BadRequestError(f"Bad request: {err.response.text}") from err
            elif status == 401:
                raise UnauthorisedError(
                    f"Request is unauthorised: {err.response.text}"
                ) from err
            elif status == 403:
                raise ForbiddenError(
                    f"Request is forbidden: {err.response.text}"
                ) from err
            raise err

    if authentication_file is None:
        _post(None)
        return

    if isinstance(authentication_file, (bytes, bytearray, memoryview)):
        content = bytes(authentication_file)
        _post(("authentication-file", content, "application/octet-stream"))
        return

    if hasattr(authentication_file, "read") and not isinstance(
        authentication_file, (str, os.PathLike)
    ):
        file_obj = t.cast(t.IO[bytes], authentication_file)
        filename = infer_filename_from_fileobj(file_obj, "authentication-file")
        _post((filename, file_obj, "application/octet-stream"))
        return

    if isinstance(authentication_file, (str, os.PathLike)):
        auth_path = pathlib.Path(authentication_file).expanduser()
        with open(auth_path, "rb") as f:
            filename = auth_path.name or infer_filename_from_fileobj(
                f, "authentication-file"
            )
            _post((filename, f, "application/octet-stream"))
        return

    raise ValueError(
        "authentication_file must be bytes/bytes-like, a binary file-like object, or a filesystem path"
    )

restore 

restore(backup: bytes | bytearray | memoryview | IO[bytes] | str | PathLike[str], repositories: list[str] | None = None, restore_system_data: bool | None = None, remove_stale_repositories: bool | None = None) -> None

Restore GraphDB instance from a backup archive.

Parameters:

  • backup

    (bytes | bytearray | memoryview | IO[bytes] | str | PathLike[str]) –

    Backup archive content as bytes/bytes-like, a binary file-like object, or a filesystem path to a .tar produced by backup.

  • repositories

    (list[str] | None, default: None ) –

    List of repositories to restore. If None (default), the parameter is omitted and all repositories found in the backup are restored. If an empty list ([]) is provided, no repositories from the backup are restored.

  • restore_system_data

    (bool | None, default: None ) –

    Whether to restore system data (users, saved queries, visual graphs, etc.). If omitted, GraphDB defaults to false. If true and no system data exists in the backup, GraphDB returns an error.

  • remove_stale_repositories

    (bool | None, default: None ) –

    Whether to remove repositories on the target instance that are not restored from the backup. If omitted, GraphDB defaults to false.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
def restore(
    self,
    backup: bytes | bytearray | memoryview | t.IO[bytes] | str | os.PathLike[str],
    repositories: list[str] | None = None,
    restore_system_data: bool | None = None,
    remove_stale_repositories: bool | None = None,
) -> None:
    """Restore GraphDB instance from a backup archive.

    Parameters:
        backup: Backup archive content as bytes/bytes-like, a binary file-like
            object, or a filesystem path to a `.tar` produced by
            [`backup`][rdflib.contrib.graphdb.client.RecoveryManagement.backup].
        repositories: List of repositories to restore. If `None` (default), the
            parameter is omitted and all repositories found in the backup are
            restored. If an empty list (`[]`) is provided, no repositories from
            the backup are restored.
        restore_system_data: Whether to restore system data (users, saved queries,
            visual graphs, etc.). If omitted, GraphDB defaults to `false`. If
            `true` and no system data exists in the backup, GraphDB returns an
            error.
        remove_stale_repositories: Whether to remove repositories on the target
            instance that are not restored from the backup. If omitted, GraphDB
            defaults to `false`.

    Raises:
        ValueError: If parameters are invalid, or if backup is not a supported type.
        BadRequestError: If the request is bad.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
    """
    if repositories is not None:
        if not isinstance(repositories, list):
            raise ValueError("repositories must be a list or None")
        if not all(isinstance(r, str) for r in repositories):
            raise ValueError("repositories must be a list of strings")
    if (
        not isinstance(restore_system_data, bool)
        and restore_system_data is not None
    ):
        raise ValueError("restore_system_data must be a bool or None")
    if (
        not isinstance(remove_stale_repositories, bool)
        and remove_stale_repositories is not None
    ):
        raise ValueError("remove_stale_repositories must be a bool or None")

    payload: dict[str, t.Any] = {}
    if repositories is not None:
        payload["repositories"] = repositories
    if restore_system_data is not None:
        payload["restoreSystemData"] = restore_system_data
    if remove_stale_repositories is not None:
        payload["removeStaleRepositories"] = remove_stale_repositories

    params_part: FileContent = (None, json.dumps(payload), "application/json")

    def _post(file_part: FileContent) -> None:
        try:
            response = self.http_client.post(
                "/rest/recovery/restore",
                files=[("params", params_part), ("file", file_part)],
            )
            response.raise_for_status()
        except httpx.HTTPStatusError as err:
            status = err.response.status_code
            if status == 400:
                raise BadRequestError(f"Bad request: {err.response.text}") from err
            elif status == 401:
                raise UnauthorisedError(
                    f"Request is unauthorised: {err.response.text}"
                ) from err
            elif status == 403:
                raise ForbiddenError(
                    f"Request is forbidden: {err.response.text}"
                ) from err
            raise err

    if isinstance(backup, (bytes, bytearray, memoryview)):
        content = bytes(backup)
        _post(("graphdb-backup.tar", content, "application/x-tar"))
        return

    if hasattr(backup, "read") and not isinstance(backup, (str, os.PathLike)):
        file_obj = t.cast(t.IO[bytes], backup)
        filename = infer_filename_from_fileobj(file_obj, "graphdb-backup.tar")
        _post((filename, file_obj, "application/x-tar"))
        return

    if isinstance(backup, (str, os.PathLike)):
        backup_path = pathlib.Path(backup).expanduser()
        with open(backup_path, "rb") as f:
            filename = backup_path.name or infer_filename_from_fileobj(
                f, "graphdb-backup.tar"
            )
            _post((filename, f, "application/x-tar"))
        return

    raise ValueError(
        "backup must be bytes/bytes-like, a binary file-like object, or a filesystem path"
    )

Repository 

Repository(identifier: str, http_client: Client)

Bases: Repository

GraphDB Repository client.

Overrides specific methods of the RDF4J Repository class and also provides GraphDB-only functionality (such as FGAC ACL management) made available through the GraphDB REST API.

Parameters:

  • identifier

    (str) –

    The identifier of the repository.

  • http_client

    (Client) –

    The httpx.Client instance.

Methods:

Attributes:

Source code in rdflib/contrib/graphdb/client.py 
1121
1122
1123
1124
1125
def __init__(self, identifier: str, http_client: httpx.Client):
    super().__init__(identifier, http_client)
    self._access_control_list_management = AccessControlListManagement(
        self.identifier, self.http_client
    )

acl property 

acl: AccessControlListManagement

cancel_server_import_file 

cancel_server_import_file(name: str) -> None

Cancel server file import operation.

Parameters:

  • name

    (str) –

    The name of the file import to interrupt.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
def cancel_server_import_file(self, name: str) -> None:
    """Cancel server file import operation.

    Parameters:
        name: The name of the file import to interrupt.

    Raises:
        BadRequestError: If the request is bad.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
    """
    try:
        params = {"name": name}
        response = self.http_client.delete(
            f"/rest/repositories/{self.identifier}/import/server",
            params=params,
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Bad request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        raise

get_server_import_files 

get_server_import_files() -> list[ImportSettings]

Get server files available for import.

Returns:

Raises:

Source code in rdflib/contrib/graphdb/client.py 
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
def get_server_import_files(self) -> list[ImportSettings]:
    """Get server files available for import.

    Returns:
        A list of files available for import.

    Raises:
        ResponseFormatError: If the response format is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        InternalServerError: If the server returns an internal error.
    """
    try:
        headers = {"Accept": "application/json"}
        response = self.http_client.get(
            f"/rest/repositories/{self.identifier}/import/server",
            headers=headers,
        )
        response.raise_for_status()
        try:
            result = []
            for item in response.json():
                # Convert nested parserSettings dict to ParserSettings instance
                if "parserSettings" in item and isinstance(
                    item["parserSettings"], dict
                ):
                    item["parserSettings"] = ParserSettings(
                        **item["parserSettings"]
                    )
                result.append(ImportSettings(**item))
            return result
        except (ValueError, TypeError) as err:
            raise ResponseFormatError(f"Failed to parse response: {err}") from err
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif err.response.status_code == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif err.response.status_code == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

health 

health(timeout: int = 5) -> bool

Repository health check.

Parameters:

  • timeout

    (int, default: 5 ) –

    A timeout parameter in seconds. If provided, the endpoint attempts to retrieve the repository within this timeout. If not, the passive check is performed.

Returns:

  • bool ( bool ) –

    True if the repository is healthy, otherwise an error is raised.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
def health(self, timeout: int = 5) -> bool:
    """Repository health check.

    Parameters:
        timeout: A timeout parameter in seconds. If provided, the endpoint attempts
            to retrieve the repository within this timeout. If not, the passive
            check is performed.

    Returns:
        bool: True if the repository is healthy, otherwise an error is raised.

    Raises:
        RepositoryNotFoundError: If the repository is not found.
        RepositoryNotHealthyError: If the repository is not healthy.
    """
    try:
        params = {"passive": str(timeout)}
        response = self.http_client.get(
            f"/repositories/{self.identifier}/health", params=params
        )
        response.raise_for_status()
        return True
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 404:
            raise RepositoryNotFoundError(
                f"Repository {self._identifier} not found."
            )
        raise RepositoryNotHealthyError(
            f"Repository {self._identifier} is not healthy. {err.response.status_code} - {err.response.text}"
        )

import_server_import_file 

import_server_import_file(server_import_body: ServerImportBody) -> None

Import a server file into the repository.

Parameters:

Raises:

Source code in rdflib/contrib/graphdb/client.py 
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
def import_server_import_file(self, server_import_body: ServerImportBody) -> None:
    """Import a server file into the repository.

    Parameters:
        server_import_body: The server import body.

    Raises:
        BadRequestError: If the request is bad.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        NotFoundError: If the request is not found.
    """
    try:
        headers = {"Content-Type": "application/json"}
        response = self.http_client.post(
            f"/rest/repositories/{self.identifier}/import/server",
            headers=headers,
            json=server_import_body.as_dict(),
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Bad request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 404:
            raise NotFoundError(
                f"Request is not found: {err.response.text}"
            ) from err
        raise

RepositoryManagement 

RepositoryManagement(http_client: Client)

GraphDB Repository Management client.

The functionality provided by this management client accepts an optional location parameter to operate on external GraphDB locations.

Methods:

  • create –

    Create a new repository.

  • delete –

    Delete a repository.

  • edit –

    Edit a repository’s configuration.

  • get –

    Get a repository’s configuration.

  • list –

    List all repositories.

  • restart –

    Restart a repository.

  • size –

    Get repository size.

  • validate –

    Validate repository data using SHACL shapes.

Attributes:

Source code in rdflib/contrib/graphdb/client.py 
1994
1995
def __init__(self, http_client: httpx.Client):
    self._http_client = http_client

http_client property 

http_client

create 

create(config: RepositoryConfigBeanCreate | str, location: str | None = None, files: FilesType | None = None)

Create a new repository.

Parameters:

  • config

    (RepositoryConfigBeanCreate | str) –

    Repository configuration. When a RepositoryConfigBeanCreate is provided, the request is sent as JSON. When a string is provided, it is treated as Turtle content and sent as multipart/form-data part config (required by GraphDB) with the content type text/turtle.

  • location

    (str | None, default: None ) –

    Optional repository location (query param location).

  • files

    (FilesType | None, default: None ) –

    Optional extra multipart parts for GraphDB-specific files (e.g. obdaFile, owlFile, propertiesFile, constraintFile, dbMetadataFile, lensesFile). Keys must be the form part names; values may be file content or httpx-style file tuples. Ignored when config is a dataclass (JSON payload).

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
def create(
    self,
    config: RepositoryConfigBeanCreate | str,
    location: str | None = None,
    files: FilesType | None = None,
):
    """Create a new repository.

    Parameters:
        config: Repository configuration. When a `RepositoryConfigBeanCreate` is
            provided, the request is sent as JSON. When a string is provided, it
            is treated as Turtle content and sent as multipart/form-data part
            `config` (required by GraphDB) with the content type `text/turtle`.
        location: Optional repository location (query param `location`).
        files: Optional extra multipart parts for GraphDB-specific files (e.g.
            `obdaFile`, `owlFile`, `propertiesFile`, `constraintFile`,
            `dbMetadataFile`, `lensesFile`). Keys must be the form part names;
            values may be file content or httpx-style file tuples. Ignored when
            `config` is a dataclass (JSON payload).

    Raises:
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        InternalServerError: If the server returns an internal error.
    """
    params = {}
    if location is not None:
        params["location"] = location

    def _normalize_file_content(field: str, value: FileContent) -> FileContent:
        if isinstance(value, tuple):
            # fill in the missing filename with the field name
            if len(value) == 2:
                filename, content = value
                return (filename or field, content)
            filename, content, content_type = value
            return (filename or field, content, content_type)
        return (field, value)

    try:
        if isinstance(config, str):
            extra_parts: list[tuple[str, FileContent]] = []
            if files is not None:
                if isinstance(files, t.Mapping):
                    extra_parts = list(files.items())
                else:
                    extra_parts = list(files)

                if any(field == "config" for field, _ in extra_parts):
                    raise ValueError(
                        "Do not pass a 'config' multipart part via files; use the config argument instead."
                    )

            multipart_files: list[tuple[str, FileContent]] = [
                ("config", ("config.ttl", config, "text/turtle"))
            ]
            for field, content in extra_parts:
                multipart_files.append(
                    (field, _normalize_file_content(field, content))
                )

            response = self.http_client.post(
                "/rest/repositories",
                params=params,
                files=multipart_files,
            )
        else:
            if files is not None:
                raise ValueError(
                    "Additional files can only be provided when config is a Turtle string."
                )
            response = self.http_client.post(
                "/rest/repositories",
                headers={"Content-Type": "application/json"},
                json=config.as_dict(),
                params=params,
            )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        status = err.response.status_code
        if status == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif status == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif status == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif status == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

delete 

delete(repository_id: str, location: str | None = None) -> None

Delete a repository.

Parameters:

  • repository_id

    (str) –

    The identifier of the repository.

  • location

    (str | None, default: None ) –

    The location of the repository.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
def delete(self, repository_id: str, location: str | None = None) -> None:
    """Delete a repository.

    Parameters:
        repository_id: The identifier of the repository.
        location: The location of the repository.

    Raises:
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        InternalServerError: If the server returns an internal error.
    """
    params = {}
    if location is not None:
        params["location"] = location
    try:
        response = self.http_client.delete(
            f"/rest/repositories/{repository_id}", params=params
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif err.response.status_code == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif err.response.status_code == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif err.response.status_code == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

edit 

edit(repository_id: str, config: RepositoryConfigBeanCreate) -> None

Edit a repository’s configuration.

Parameters:

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
def edit(self, repository_id: str, config: RepositoryConfigBeanCreate) -> None:
    """Edit a repository's configuration.

    Parameters:
        repository_id: The identifier of the repository.
        config: The repository configuration.

    Raises:
        BadRequestError: If the request is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        InternalServerError: If the server returns an internal error.
    """
    headers = {
        "Content-Type": "application/json",
    }
    try:
        response = self.http_client.put(
            f"/rest/repositories/{repository_id}",
            headers=headers,
            json=config.as_dict(),
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 400:
            raise BadRequestError(f"Invalid request: {err.response.text}") from err
        elif err.response.status_code == 401:
            raise UnauthorisedError(
                f"Request is unauthorised: {err.response.text}"
            ) from err
        elif err.response.status_code == 403:
            raise ForbiddenError(
                f"Request is forbidden: {err.response.text}"
            ) from err
        elif err.response.status_code == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

get 

get(repository_id: str, content_type: Literal['application/json'], location: str | None = None) -> RepositoryConfigBean

get(repository_id: str, content_type: None = None, location: str | None = None) -> RepositoryConfigBean

get(repository_id: str, content_type: Literal['text/turtle'], location: str | None = None) -> Graph

get(repository_id: str, content_type: str, location: str | None = None) -> RepositoryConfigBean | Graph

get(repository_id: str, content_type: str | None = None, location: str | None = None) -> RepositoryConfigBean | Graph

Get a repository’s configuration.

Parameters:

  • repository_id

    (str) –

    The identifier of the repository.

  • content_type

    (str | None, default: None ) –

    The content type of the response. Can be application/json or text/turtle. Defaults to application/json.

  • location

    (str | None, default: None ) –

    The location of the repository.

Returns:

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
def get(
    self,
    repository_id: str,
    content_type: str | None = None,
    location: str | None = None,
) -> RepositoryConfigBean | Graph:
    """Get a repository's configuration.

    Parameters:
        repository_id: The identifier of the repository.
        content_type: The content type of the response. Can be `application/json` or
            `text/turtle`. Defaults to `application/json`.
        location: The location of the repository.

    Returns:
        RepositoryConfigBean: The repository configuration.
        Graph: The repository configuration in RDF.

    Raises:
        BadRequestError: If the content type is not supported.
        ResponseFormatError: If the response cannot be parsed.
        RepositoryNotFoundError: If the repository is not found.
        InternalServerError: If the server returns an internal error.
    """
    if content_type is None:
        content_type = "application/json"
    if content_type not in ("application/json", "text/turtle"):
        raise ValueError(f"Unsupported content type: {content_type}.")
    headers = {"Accept": content_type}
    params = {}
    if location is not None:
        params["location"] = location
    try:
        response = self.http_client.get(
            f"/rest/repositories/{repository_id}", headers=headers, params=params
        )
        response.raise_for_status()

        if content_type == "application/json":
            try:
                return RepositoryConfigBean(**response.json())
            except (ValueError, TypeError) as err:
                raise ResponseFormatError(
                    "Failed to parse GraphDB response."
                ) from err
        elif content_type == "text/turtle":
            try:
                return Graph().parse(data=response.text, format="turtle")
            except Exception as err:
                raise ResponseFormatError(f"Error parsing RDF: {err}") from err
        else:
            raise ValueError(f"Unhandled content type: {content_type}.")
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 404:
            raise RepositoryNotFoundError(
                f"Repository {repository_id} not found."
            ) from err
        elif err.response.status_code == 500:
            raise InternalServerError("Internal server error.") from err
        raise

list 

list(location: str | None = None) -> list[GraphDBRepository]

List all repositories.

Parameters:

  • location

    (str | None, default: None ) –

    The location of the repositories.

Returns:

Raises:

Source code in rdflib/contrib/graphdb/client.py 
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
def list(self, location: str | None = None) -> list[GraphDBRepository]:
    """List all repositories.

    Parameters:
        location: The location of the repositories.

    Returns:
        list[GraphDBRepository]: List of GraphDB repositories.

    Raises:
        InternalServerError: If the server returns an internal error.
        ResponseFormatError: If the response cannot be parsed.
    """
    params = {}
    if location is not None:
        params["location"] = location
    try:
        response = self.http_client.get("/rest/repositories", params=params)
        response.raise_for_status()
        try:
            return [GraphDBRepository.from_dict(repo) for repo in response.json()]
        except (ValueError, TypeError) as err:
            raise ResponseFormatError(
                f"Failed to parse GraphDB response: {err}"
            ) from err
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

restart 

restart(repository_id: str, sync: bool | None = None, location: str | None = None) -> str

Restart a repository.

Parameters:

  • repository_id

    (str) –

    The identifier of the repository.

  • sync

    (bool | None, default: None ) –

    Whether to sync the repository.

  • location

    (str | None, default: None ) –

    The location of the repository.

Returns:

  • str ( str ) –

    The response text.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
def restart(
    self, repository_id: str, sync: bool | None = None, location: str | None = None
) -> str:
    """Restart a repository.

    Parameters:
        repository_id: The identifier of the repository.
        sync: Whether to sync the repository.
        location: The location of the repository.

    Returns:
        str: The response text.

    Raises:
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        RepositoryNotFoundError: If the repository is not found.
    """
    params = {}
    if sync is not None:
        params["sync"] = str(sync).lower()
    if location is not None:
        params["location"] = location
    try:
        response = self.http_client.post(
            f"/rest/repositories/{repository_id}/restart", params=params
        )
        response.raise_for_status()
        return response.text
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 401:
            raise UnauthorisedError("Request is unauthorised.") from err
        elif err.response.status_code == 403:
            raise ForbiddenError("Request is forbidden.") from err
        elif err.response.status_code == 404:
            raise RepositoryNotFoundError(
                f"Repository {repository_id} not found."
            ) from err
        raise

size 

size(repository_id: str, location: str | None = None) -> RepositorySizeInfo

Get repository size.

Parameters:

  • repository_id

    (str) –

    The identifier of the repository.

  • location

    (str | None, default: None ) –

    The location of the repository.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
def size(
    self, repository_id: str, location: str | None = None
) -> RepositorySizeInfo:
    """Get repository size.

    Parameters:
        repository_id: The identifier of the repository.
        location: The location of the repository.

    Raises:
        ResponseFormatError: If the response cannot be parsed.
        InternalServerError: If the server returns an internal error.
    """
    params = {}
    if location:
        params["location"] = location
    try:
        response = self.http_client.get(
            f"/rest/repositories/{repository_id}/size", params=params
        )
        response.raise_for_status()
        try:
            return RepositorySizeInfo(**response.json())
        except (ValueError, TypeError) as err:
            raise ResponseFormatError("Failed to parse GraphDB response.") from err
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

validate 

validate(repository_id: str, *, content_type: str, content: str, location: str | None = None, shapes_repository_id: None = None) -> str

validate(repository_id: str, *, content: IO[bytes], content_type: str | None = None, location: str | None = None, shapes_repository_id: None = None) -> str

validate(repository_id: str, *, shapes_repository_id: str, location: str | None = None) -> str

validate(repository_id: str, *, content_type: str | None = None, content: str | IO[bytes] | None = None, location: str | None = None, shapes_repository_id: str | None = None) -> str

Validate repository data using SHACL shapes.

Parameters:

  • repository_id

    (str) –

    The identifier of the repository.

  • content_type

    (str | None, default: None ) –

    Content type of the request body (required for text payloads).

  • content

    (str | IO[bytes] | None, default: None ) –

    SHACL shapes payload; string for text-based validation or file-like (binary) object for multipart validation.

  • location

    (str | None, default: None ) –

    Optional repository location.

  • shapes_repository_id

    (str | None, default: None ) –

    ID of repository containing SHACL shapes; when provided, no content is sent and shapes are fetched from that repository.

Returns:

  • str ( str ) –

    Validation report as RDF Turtle.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
def validate(
    self,
    repository_id: str,
    *,
    content_type: str | None = None,
    content: str | t.IO[bytes] | None = None,
    location: str | None = None,
    shapes_repository_id: str | None = None,
) -> str:
    """Validate repository data using SHACL shapes.

    Parameters:
        repository_id: The identifier of the repository.
        content_type: Content type of the request body (required for text payloads).
        content: SHACL shapes payload; string for text-based validation or file-like
            (binary) object for multipart validation.
        location: Optional repository location.
        shapes_repository_id: ID of repository containing SHACL shapes; when
            provided, no content is sent and shapes are fetched from that
            repository.

    Returns:
        str: Validation report as RDF Turtle.

    Raises:
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        InternalServerError: If the server returns an internal error.
    """
    params = {}
    if location is not None:
        params["location"] = location

    if shapes_repository_id is not None:
        if content is not None:
            raise ValueError(
                "content must not be provided when shapes_repository_id is set."
            )
        if content_type is not None:
            raise ValueError(
                "content_type must not be provided when shapes_repository_id is set."
            )
        headers = {"Accept": "text/turtle"}
        try:
            response = self.http_client.post(
                url=f"/rest/repositories/{repository_id}/validate/repository/{shapes_repository_id}",
                params=params,
                headers=headers,
            )
            response.raise_for_status()
            return response.text
        except httpx.HTTPStatusError as err:
            status = err.response.status_code
            if status == 401:
                raise UnauthorisedError("Request is unauthorised.") from err
            elif status == 403:
                raise ForbiddenError("Request is forbidden.") from err
            elif status == 500:
                raise InternalServerError(
                    f"Internal server error: {err.response.text}"
                ) from err
            raise

    if content is None:
        raise ValueError("content must be provided.")

    is_file_like = hasattr(content, "read") and not isinstance(content, str)

    if is_file_like:
        headers = {"Accept": "text/turtle"}
        file_part = (
            "shapes.ttl",
            t.cast(t.IO[bytes], content),
            content_type or "text/turtle",
        )
        files: FilesType = {"file": file_part}
        try:
            response = self.http_client.post(
                url=f"/rest/repositories/{repository_id}/validate/file",
                params=params,
                headers=headers,
                files=files,
            )
            response.raise_for_status()
            return response.text
        except httpx.HTTPStatusError as err:
            status = err.response.status_code
            if status == 401:
                raise UnauthorisedError("Request is unauthorised.") from err
            elif status == 403:
                raise ForbiddenError("Request is forbidden.") from err
            elif status == 500:
                raise InternalServerError(
                    f"Internal server error: {err.response.text}"
                ) from err
            raise
    else:
        if not content_type:
            raise ValueError("content_type must be provided for text validation.")

        headers = {"Content-Type": content_type, "Accept": "text/turtle"}
        try:
            response = self.http_client.post(
                url=f"/rest/repositories/{repository_id}/validate/text",
                params=params,
                headers=headers,
                content=content,
            )
            response.raise_for_status()
            return response.text
        except httpx.HTTPStatusError as err:
            status = err.response.status_code
            if status == 401:
                raise UnauthorisedError("Request is unauthorised.") from err
            elif status == 403:
                raise ForbiddenError("Request is forbidden.") from err
            elif status == 500:
                raise InternalServerError(
                    f"Internal server error: {err.response.text}"
                ) from err
            raise

RepositoryManager 

RepositoryManager(http_client: Client)

Bases: RepositoryManager

GraphDB Repository Manager.

This manager client overrides specific RDF4J RepositoryManager class methods to provide GraphDB-specific implementations.

Methods:

  • get –

    Get a repository by ID.

Source code in rdflib/contrib/rdf4j/client.py 
1074
1075
def __init__(self, http_client: httpx.Client):
    self._http_client = http_client

get 

get(repository_id: str) -> Repository

Get a repository by ID.

Note

This performs a health check before returning the repository object.

Parameters:

  • repository_id

    (str) –

    The identifier of the repository.

Returns:

  • Repository ( Repository ) –

    The repository instance.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
def get(self, repository_id: str) -> Repository:
    """Get a repository by ID.

    !!! Note
        This performs a health check before returning the repository object.

    Parameters:
        repository_id: The identifier of the repository.

    Returns:
        Repository: The repository instance.

    Raises:
        RepositoryNotFoundError: If the repository is not found.
        RepositoryNotHealthyError: If the repository is not healthy.
    """
    _repo = super().get(repository_id)
    return Repository(_repo.identifier, _repo.http_client)

SecurityManagement 

SecurityManagement(http_client: Client)

GraphDB Security Management client.

Methods:

Attributes:

Source code in rdflib/contrib/graphdb/client.py 
2530
2531
def __init__(self, http_client: httpx.Client):
    self._http_client = http_client

enabled property writable 

enabled: bool

Check if security is enabled.

Returns:

  • bool ( bool ) –

    True if security is enabled, False otherwise.

Raises:

http_client property 

http_client

get_free_access_details 

get_free_access_details()

Check if free access is enabled.

Returns:

  • FreeAccessSettings –

    The free access settings.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
def get_free_access_details(self):
    """
    Check if free access is enabled.

    Returns:
        FreeAccessSettings: The free access settings.

    Raises:
        ResponseFormatError: If the response format is invalid.
        InternalServerError: If the server returns an internal error.
    """
    try:
        headers = {"Accept": "application/json"}
        response = self.http_client.get(
            "/rest/security/free-access", headers=headers
        )
        response.raise_for_status()
        try:
            return FreeAccessSettings(**response.json())
        except (ValueError, TypeError) as err:
            raise ResponseFormatError(
                f"Failed to parse GraphDB response: {err}"
            ) from err
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

set_free_access_details 

set_free_access_details(free_access_settings: FreeAccessSettings)

Enable or disable free access.

Parameters:

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
def set_free_access_details(self, free_access_settings: FreeAccessSettings):
    """
    Enable or disable free access.

    Parameters:
        free_access_settings: The free access settings.

    Raises:
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        PreconditionFailedError: If the precondition is failed.
    """
    try:
        headers = {"Content-Type": "application/json", "Accept": "application/json"}
        response = self.http_client.post(
            "/rest/security/free-access",
            headers=headers,
            json=free_access_settings.as_dict(),
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 401:
            raise UnauthorisedError("Request is unauthorised.") from err
        elif err.response.status_code == 403:
            raise ForbiddenError("Request is forbidden.") from err
        elif err.response.status_code == 412:
            raise PreconditionFailedError("Precondition failed.") from err
        raise

UserManagement 

UserManagement(http_client: Client)

GraphDB User Management client.

Methods:

Attributes:

Source code in rdflib/contrib/graphdb/client.py 
2661
2662
def __init__(self, http_client: httpx.Client):
    self._http_client = http_client

http_client property 

http_client

create 

create(username: str, user: UserCreate) -> None

Create a user.

Parameters:

  • username

    (str) –

    The username of the user.

  • user

    (UserCreate) –

    The user to create.

Raises:

  • TypeError –

    if username is not a string or user is not an instance of UserCreate.

  • BadRequestError –

    If the request is bad.

  • UnauthorisedError –

    If the request is unauthorised.

  • ForbiddenError –

    If the request is forbidden.

Source code in rdflib/contrib/graphdb/client.py 
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
def create(self, username: str, user: UserCreate) -> None:
    """
    Create a user.

    Parameters:
        username: The username of the user.
        user: The user to create.

    Raises:
        TypeError: if username is not a string or user is not an instance of UserCreate.
        BadRequestError: If the request is bad.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
    """
    if not isinstance(username, str):
        raise TypeError("Username must be a string.")
    if not isinstance(user, UserCreate):
        raise TypeError("User must be an instance of UserCreate.")

    try:
        headers = {"Content-Type": "application/json"}
        response = self.http_client.post(
            f"/rest/security/users/{username}", headers=headers, json=user.as_dict()
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 400:
            raise BadRequestError(f"Bad request. {err.response.text}") from err
        elif err.response.status_code == 401:
            raise UnauthorisedError("Request is unauthorised.") from err
        elif err.response.status_code == 403:
            raise ForbiddenError("Request is forbidden.") from err
        raise

custom_roles 

custom_roles(username: str) -> List[str]

Retrieve custom roles associated with the user.

Parameters:

  • username

    (str) –

    The username of the user.

Returns:

  • List[str] –

    list[str]: The custom roles for the user.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
def custom_roles(self, username: str) -> t.List[str]:
    """
    Retrieve custom roles associated with the user.

    Parameters:
        username: The username of the user.

    Returns:
        list[str]: The custom roles for the user.

    Raises:
        TypeError: if username is not a string.
        ForbiddenError: If the request is forbidden.
        NotFoundError: If the user is not found.
        InternalServerError: If the request fails.
    """
    if not isinstance(username, str):
        raise TypeError("Username must be a string.")

    try:
        response = self.http_client.get(
            f"/rest/security/users/{username}/custom-roles"
        )
        response.raise_for_status()
        return response.json()
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 403:
            raise ForbiddenError("Request is forbidden.") from err
        elif err.response.status_code == 404:
            raise NotFoundError("User not found.") from err
        elif err.response.status_code == 500:
            raise InternalServerError("Internal server error.") from err
        raise

delete 

delete(username: str) -> None

Delete a user.

Parameters:

  • username

    (str) –

    The username of the user.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
def delete(self, username: str) -> None:
    """
    Delete a user.

    Parameters:
        username: The username of the user.

    Raises:
        TypeError: if username is not a string.
        BadRequestError: If the request is bad.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        NotFoundError: If the user is not found.
    """
    if not isinstance(username, str):
        raise TypeError("Username must be a string.")

    try:
        response = self.http_client.delete(f"/rest/security/users/{username}")
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 400:
            raise BadRequestError(f"Bad request. {err.response.text}") from err
        elif err.response.status_code == 401:
            raise UnauthorisedError("Request is unauthorised.") from err
        elif err.response.status_code == 403:
            raise ForbiddenError("Request is forbidden.") from err
        elif err.response.status_code == 404:
            raise NotFoundError("User not found.") from err
        raise

get 

get(username: str) -> User

Get a user.

Parameters:

  • username

    (str) –

    The username of the user.

Returns:

  • User ( User ) –

    The user.

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
def get(self, username: str) -> User:
    """
    Get a user.

    Parameters:
        username: The username of the user.

    Returns:
        User: The user.

    Raises:
        ResponseFormatError: If the response format is invalid.
        ForbiddenError: If the request is forbidden.
        NotFoundError: If the user is not found.
        InternalServerError: If the server returns an internal error.
    """
    try:
        headers = {"Accept": "application/json"}
        response = self.http_client.get(
            f"/rest/security/users/{username}", headers=headers
        )
        response.raise_for_status()
        try:
            return User(**response.json())
        except (ValueError, TypeError) as err:
            raise ResponseFormatError(
                f"Failed to parse GraphDB response: {err}"
            ) from err
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 403:
            raise ForbiddenError("Request is forbidden.") from err
        elif err.response.status_code == 404:
            raise NotFoundError("User not found.") from err
        elif err.response.status_code == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

list 

list() -> list[User]

Get all users.

Returns:

Raises:

Source code in rdflib/contrib/graphdb/client.py 
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
def list(self) -> list[User]:
    """
    Get all users.

    Returns:
        A list of users.

    Raises:
        ResponseFormatError: If the response format is invalid.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        PreconditionFailedError: If the precondition is failed.
        InternalServerError: If the server returns an internal error.
    """
    headers = {"Accept": "application/json"}
    try:
        response = self.http_client.get("/rest/security/users", headers=headers)
        response.raise_for_status()
        try:
            return [User(**user) for user in response.json()]
        except (ValueError, TypeError) as err:
            raise ResponseFormatError(
                f"Failed to parse GraphDB response: {err}"
            ) from err
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 401:
            raise UnauthorisedError("Request is unauthorised.") from err
        elif err.response.status_code == 403:
            raise ForbiddenError("Request is forbidden.") from err
        elif err.response.status_code == 412:
            raise PreconditionFailedError("Precondition failed.") from err
        elif err.response.status_code == 500:
            raise InternalServerError(
                f"Internal server error: {err.response.text}"
            ) from err
        raise

overwrite 

overwrite(username: str, user: User) -> None

Overwrite a user.

Parameters:

  • username

    (str) –

    The username of the user.

  • user

    (User) –

    The user to overwrite.

Raises:

  • TypeError –

    if username is not a string or user is not an instance of User.

  • UnauthorisedError –

    If the request is unauthorised.

  • ForbiddenError –

    If the request is forbidden.

  • NotFoundError –

    If the user is not found.

Source code in rdflib/contrib/graphdb/client.py 
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
def overwrite(self, username: str, user: User) -> None:
    """
    Overwrite a user.

    Parameters:
        username: The username of the user.
        user: The user to overwrite.

    Raises:
        TypeError: if username is not a string or user is not an instance of User.
        UnauthorisedError: If the request is unauthorised.
        ForbiddenError: If the request is forbidden.
        NotFoundError: If the user is not found.
    """
    if not isinstance(username, str):
        raise TypeError("Username must be a string.")
    if not isinstance(user, User):
        raise TypeError("User must be an instance of User.")

    try:
        headers = {"Content-Type": "application/json"}
        response = self.http_client.put(
            f"/rest/security/users/{username}", headers=headers, json=user.as_dict()
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 401:
            raise UnauthorisedError("Request is unauthorised.") from err
        elif err.response.status_code == 403:
            raise ForbiddenError("Request is forbidden.") from err
        elif err.response.status_code == 404:
            raise NotFoundError("User not found.") from err
        raise

update 

update(username: str, user: UserUpdate | dict[str, Any]) -> None

Update a user.

Note

Certain user fields are not updatable using PATCH. For example, at the time of writing, grantedAuthorities are not updatable, but appSettings are.

Parameters:

  • username

    (str) –

    The username of the user.

  • user

    (UserUpdate | dict[str, Any]) –

    The user data to update, either as a UserUpdate instance or a dict.

Raises:

  • TypeError –

    if username is not a string or user is not an instance of UserUpdate or dict.

  • ForbiddenError –

    If the request is forbidden.

  • PreconditionFailedError –

    If the precondition is failed.

Source code in rdflib/contrib/graphdb/client.py 
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
def update(self, username: str, user: UserUpdate | dict[str, t.Any]) -> None:
    """
    Update a user.

    !!! Note
        Certain user fields are not updatable using PATCH. For example, at the
        time of writing, `grantedAuthorities` are not updatable, but `appSettings` are.

    Parameters:
        username: The username of the user.
        user: The user data to update, either as a UserUpdate instance or a dict.

    Raises:
        TypeError: if username is not a string or user is not an instance of UserUpdate or dict.
        ForbiddenError: If the request is forbidden.
        PreconditionFailedError: If the precondition is failed.
    """
    if not isinstance(username, str):
        raise TypeError("Username must be a string.")
    if not isinstance(user, (UserUpdate, dict)):
        raise TypeError("User must be an instance of UserUpdate or dict.")

    if isinstance(user, UserUpdate):
        user_data = user.as_dict()
    else:
        user_data = user

    try:
        headers = {"Content-Type": "application/json"}
        response = self.http_client.patch(
            f"/rest/security/users/{username}", headers=headers, json=user_data
        )
        response.raise_for_status()
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 403:
            raise ForbiddenError("Request is forbidden.") from err
        elif err.response.status_code == 412:
            raise PreconditionFailedError("Precondition failed.") from err
        raise