Skip to content

client

RDF4J client module.

Classes:

Attributes:

ObjectType module-attribute 

ObjectType = Union[URIRef, Literal, None]

PredicateType module-attribute 

PredicateType = Union[URIRef, None]

SubjectType module-attribute 

SubjectType = Union[URIRef, None]

GraphStoreManager 

GraphStoreManager(identifier: str, http_client: Client)

An RDF4J Graph Store Protocol Client.

Parameters:

  • identifier

    (str) –

    The identifier of the repository.

  • http_client

    (Client) –

    The httpx.Client instance.

Methods:

  • add –

    Add statements to the specified graph.

  • clear –

    Clear all statements in the specified graph.

  • get –

    Fetch all statements in the specified graph.

  • overwrite –

    Overwrite statements in the specified graph.

Attributes:

Source code in rdflib/contrib/rdf4j/client.py 
186
187
188
189
def __init__(self, identifier: str, http_client: httpx.Client):
    self._identifier = identifier
    self._http_client = http_client
    self._content_type = "application/n-triples"

http_client property 

http_client

identifier property 

identifier

Repository identifier.

add 

add(graph_name: URIRef | str, data: str | bytes | BinaryIO | Graph)

Add statements to the specified graph.

Parameters:

  • graph_name

    (URIRef | str) –

    The graph name of the graph.

    For the default graph, use DATASET_DEFAULT_GRAPH_ID.

  • data

    (str | bytes | BinaryIO | Graph) –

    The RDF data to add.

Source code in rdflib/contrib/rdf4j/client.py 
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
def add(self, graph_name: URIRef | str, data: str | bytes | BinaryIO | Graph):
    """Add statements to the specified graph.

    Parameters:
        graph_name: The graph name of the graph.

            For the default graph, use
            [`DATASET_DEFAULT_GRAPH_ID`][rdflib.graph.DATASET_DEFAULT_GRAPH_ID].

        data: The RDF data to add.
    """
    if not graph_name:
        raise ValueError("Graph name must be provided.")
    validate_graph_name(graph_name)
    stream, should_close = rdf_payload_to_stream(data)
    headers = {
        "Content-Type": self._content_type,
    }
    params = self._build_graph_name_params(graph_name) or None
    try:
        response = self.http_client.post(
            self._build_url(graph_name),
            headers=headers,
            params=params,
            content=stream,
        )
        response.raise_for_status()
    finally:
        if should_close:
            stream.close()

clear 

clear(graph_name: URIRef | str)

Clear all statements in the specified graph.

Parameters:

Source code in rdflib/contrib/rdf4j/client.py 
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
def clear(self, graph_name: URIRef | str):
    """Clear all statements in the specified graph.

    Parameters:
        graph_name: The graph name of the graph.

            For the default graph, use
            [`DATASET_DEFAULT_GRAPH_ID`][rdflib.graph.DATASET_DEFAULT_GRAPH_ID].
    """
    if not graph_name:
        raise ValueError("Graph name must be provided.")
    validate_graph_name(graph_name)
    params = self._build_graph_name_params(graph_name) or None
    response = self.http_client.delete(self._build_url(graph_name), params=params)
    response.raise_for_status()

get 

get(graph_name: URIRef | str) -> Graph

Fetch all statements in the specified graph.

Parameters:

Returns:

  • Graph –

    A Graph object containing all statements in the graph.

Source code in rdflib/contrib/rdf4j/client.py 
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
def get(self, graph_name: URIRef | str) -> Graph:
    """Fetch all statements in the specified graph.

    Parameters:
        graph_name: The graph name of the graph.

            For the default graph, use
            [`DATASET_DEFAULT_GRAPH_ID`][rdflib.graph.DATASET_DEFAULT_GRAPH_ID].

    Returns:
        A [`Graph`][rdflib.graph.Graph] object containing all statements in the
            graph.
    """
    if not graph_name:
        raise ValueError("Graph name must be provided.")
    validate_graph_name(graph_name)
    headers = {
        "Accept": self._content_type,
    }
    params = self._build_graph_name_params(graph_name) or None

    response = self.http_client.get(
        self._build_url(graph_name),
        headers=headers,
        params=params,
    )
    response.raise_for_status()

    return Graph(identifier=graph_name).parse(
        data=response.text, format=self._content_type
    )

overwrite 

overwrite(graph_name: URIRef | str, data: str | bytes | BinaryIO | Graph)

Overwrite statements in the specified graph.

Parameters:

  • graph_name

    (URIRef | str) –

    The graph name of the graph.

    For the default graph, use DATASET_DEFAULT_GRAPH_ID.

  • data

    (str | bytes | BinaryIO | Graph) –

    The RDF data to overwrite with.

Source code in rdflib/contrib/rdf4j/client.py 
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
def overwrite(self, graph_name: URIRef | str, data: str | bytes | BinaryIO | Graph):
    """Overwrite statements in the specified graph.

    Parameters:
        graph_name: The graph name of the graph.

            For the default graph, use
            [`DATASET_DEFAULT_GRAPH_ID`][rdflib.graph.DATASET_DEFAULT_GRAPH_ID].

        data: The RDF data to overwrite with.
    """
    if not graph_name:
        raise ValueError("Graph name must be provided.")
    validate_graph_name(graph_name)
    stream, should_close = rdf_payload_to_stream(data)
    headers = {
        "Content-Type": self._content_type,
    }
    params = self._build_graph_name_params(graph_name) or None
    try:
        response = self.http_client.put(
            self._build_url(graph_name),
            headers=headers,
            params=params,
            content=stream,
        )
        response.raise_for_status()
    finally:
        if should_close:
            stream.close()

NamespaceListingResult dataclass 

NamespaceListingResult(prefix: str, namespace: str)

RDF4J namespace and prefix name result.

Attributes:

namespace instance-attribute 

namespace: str

prefix instance-attribute 

prefix: str

RDF4JClient 

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

RDF4J client.

This client and its inner management objects perform HTTP requests via httpx and may raise httpx-specific exceptions. Errors documented by RDF4J in its protocol 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 RDF4J 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:

Attributes:

Source code in rdflib/contrib/rdf4j/client.py 
1202
1203
1204
1205
1206
1207
1208
1209
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
def __init__(
    self,
    base_url: str,
    auth: tuple[str, str] | str | None = None,
    timeout: float | httpx.Timeout = 30.0,
    **kwargs: Any,
):
    if not base_url.endswith("/"):
        base_url += "/"

    httpx_auth: tuple[str, str] | None = None
    if isinstance(auth, tuple):
        httpx_auth = auth
    elif isinstance(auth, str):
        headers = kwargs.get("headers", {})
        headers["Authorization"] = auth
        kwargs["headers"] = headers

    self._http_client = httpx.Client(
        base_url=base_url, auth=httpx_auth, timeout=timeout, **kwargs
    )
    self._repository_manager = RepositoryManager(self.http_client)
    try:
        protocol_version = self.protocol
    except httpx.RequestError as err:
        self.close()
        raise RDF4JUnsupportedProtocolError(
            f"Failed to check protocol version: {err}"
        ) from err
    if protocol_version < 12:
        self.close()
        raise RDF4JUnsupportedProtocolError(
            f"RDF4J server protocol version {protocol_version} is not supported. Minimum required version is 12."
        )

http_client property 

http_client

protocol property 

protocol: float

The RDF4J REST API protocol version.

Returns:

  • float –

    The protocol version number.

repositories property 

repositories: RepositoryManager

Server-level repository management operations.

__enter__ 

__enter__()
Source code in rdflib/contrib/rdf4j/client.py 
1237
1238
def __enter__(self):
    return self

__exit__ 

__exit__(exc_type, exc_val, exc_tb)
Source code in rdflib/contrib/rdf4j/client.py 
1240
1241
def __exit__(self, exc_type, exc_val, exc_tb):
    self.close()

close 

close()

Close the underlying httpx.Client.

Source code in rdflib/contrib/rdf4j/client.py 
1263
1264
1265
def close(self):
    """Close the underlying httpx.Client."""
    self.http_client.close()

RDF4JNamespaceManager 

RDF4JNamespaceManager(identifier: str, http_client: Client)

A namespace manager for RDF4J repositories.

Parameters:

  • identifier

    (str) –

    The identifier of the repository.

  • http_client

    (Client) –

    The httpx.Client instance.

Methods:

  • clear –

    Clear all namespace declarations in the repository.

  • get –

    Get the namespace URI for a given prefix.

  • list –

    List all namespace declarations in the repository.

  • remove –

    Remove the namespace declaration for a given prefix.

  • set –

    Set the namespace URI for a given prefix.

Attributes:

Source code in rdflib/contrib/rdf4j/client.py 
61
62
63
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.

clear 

clear()

Clear all namespace declarations in the repository.

Source code in rdflib/contrib/rdf4j/client.py 
104
105
106
107
108
109
110
111
112
def clear(self):
    """Clear all namespace declarations in the repository."""
    headers = {
        "Accept": "application/sparql-results+json",
    }
    response = self.http_client.delete(
        f"/repositories/{self.identifier}/namespaces", headers=headers
    )
    response.raise_for_status()

get 

get(prefix: str) -> str | None

Get the namespace URI for a given prefix.

Parameters:

  • prefix

    (str) –

    The prefix to lookup.

Returns:

  • str | None –

    The namespace URI or None if not found.

Source code in rdflib/contrib/rdf4j/client.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
def get(self, prefix: str) -> str | None:
    """Get the namespace URI for a given prefix.

    Parameters:
        prefix: The prefix to lookup.

    Returns:
        The namespace URI or `None` if not found.
    """
    if not prefix:
        raise ValueError("Prefix cannot be empty.")
    headers = {
        "Accept": "text/plain",
    }
    try:
        response = self.http_client.get(
            f"/repositories/{self.identifier}/namespaces/{prefix}", headers=headers
        )
        response.raise_for_status()
        return response.text
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 404:
            return None
        raise

list 

list() -> list[NamespaceListingResult]

List all namespace declarations in the repository.

Returns:

Raises:

Source code in rdflib/contrib/rdf4j/client.py 
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def list(self) -> list[NamespaceListingResult]:
    """List all namespace declarations in the repository.

    Returns:
        list[NamespaceListingResult]: List of namespace and prefix name results.

    Raises:
        RepositoryResponseFormatError: If the response format is unrecognized.
    """
    headers = {
        "Accept": "application/sparql-results+json",
    }
    response = self.http_client.get(
        f"/repositories/{self.identifier}/namespaces", headers=headers
    )
    response.raise_for_status()

    try:
        data = response.json()
        results = data["results"]["bindings"]
        return [
            NamespaceListingResult(
                prefix=row["prefix"]["value"],
                namespace=row["namespace"]["value"],
            )
            for row in results
        ]
    except (KeyError, ValueError) as err:
        raise RepositoryResponseFormatError(f"Unrecognised response format: {err}")

remove 

remove(prefix: str)

Remove the namespace declaration for a given prefix.

Parameters:

  • prefix

    (str) –

    The prefix to remove.

Source code in rdflib/contrib/rdf4j/client.py 
164
165
166
167
168
169
170
171
172
173
174
175
def remove(self, prefix: str):
    """Remove the namespace declaration for a given prefix.

    Parameters:
        prefix: The prefix to remove.
    """
    if not prefix:
        raise ValueError("Prefix cannot be empty.")
    response = self.http_client.delete(
        f"/repositories/{self.identifier}/namespaces/{prefix}"
    )
    response.raise_for_status()

set 

set(prefix: str, namespace: str)

Set the namespace URI for a given prefix.

Note

If the prefix was previously mapped to a different namespace, this will be overwritten.

Parameters:

  • prefix

    (str) –

    The prefix to set.

  • namespace

    (str) –

    The namespace URI to set.

Source code in rdflib/contrib/rdf4j/client.py 
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
def set(self, prefix: str, namespace: str):
    """Set the namespace URI for a given prefix.

    !!! note
        If the prefix was previously mapped to a different namespace, this will be
        overwritten.

    Parameters:
        prefix: The prefix to set.
        namespace: The namespace URI to set.
    """
    if not prefix:
        raise ValueError("Prefix cannot be empty.")
    if not namespace:
        raise ValueError("Namespace cannot be empty.")
    headers = {
        "Content-Type": "text/plain",
    }
    response = self.http_client.put(
        f"/repositories/{self.identifier}/namespaces/{prefix}",
        headers=headers,
        content=namespace,
    )
    response.raise_for_status()

Repository 

Repository(identifier: str, http_client: Client)

RDF4J repository client.

Parameters:

  • identifier

    (str) –

    The identifier of the repository.

  • http_client

    (Client) –

    The httpx.Client instance.

Methods:

  • delete –

    Deletes statements from the repository matching the filtering parameters.

  • get –

    Get RDF statements from the repository matching the filtering parameters.

  • graph_names –

    Get a list of all graph names in the repository.

  • health –

    Repository health check.

  • overwrite –

    Upload and overwrite statements in the repository.

  • query –

    Execute a SPARQL query against the repository.

  • size –

    The number of statements in the repository or in the specified graph name.

  • transaction –

    Create a new transaction for the repository.

  • update –

    Execute a SPARQL update operation on the repository.

  • upload –

    Upload and append statements to the repository.

Attributes:

Source code in rdflib/contrib/rdf4j/client.py 
365
366
367
368
369
def __init__(self, identifier: str, http_client: httpx.Client):
    self._identifier = identifier
    self._http_client = http_client
    self._namespace_manager: RDF4JNamespaceManager | None = None
    self._graph_store_manager: GraphStoreManager | None = None

graphs property 

graphs: GraphStoreManager

Graph store manager for the repository.

http_client property 

http_client

identifier property 

identifier

Repository identifier.

namespaces property 

namespaces: RDF4JNamespaceManager

Namespace manager for the repository.

delete 

delete(subj: SubjectType = None, pred: PredicateType = None, obj: ObjectType = None, graph_name: URIRef | Iterable[URIRef] | str | None = None) -> None

Deletes statements from the repository matching the filtering parameters.

Note

The terms for subj, pred, obj or graph_name cannot be BNodes.

Parameters:

  • subj

    (SubjectType, default: None ) –

    Subject of the statement to filter by, or None to match all.

  • pred

    (PredicateType, default: None ) –

    Predicate of the statement to filter by, or None to match all.

  • obj

    (ObjectType, default: None ) –

    Object of the statement to filter by, or None to match all.

  • graph_name

    (URIRef | Iterable[URIRef] | str | None, default: None ) –

    Graph name(s) to restrict to.

    The default value None queries all graphs.

    To query just the default graph, use DATASET_DEFAULT_GRAPH_ID.

Source code in rdflib/contrib/rdf4j/client.py 
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
716
717
718
719
720
721
722
def delete(
    self,
    subj: SubjectType = None,
    pred: PredicateType = None,
    obj: ObjectType = None,
    graph_name: URIRef | Iterable[URIRef] | str | None = None,
) -> None:
    """Deletes statements from the repository matching the filtering parameters.

    !!! Note
        The terms for `subj`, `pred`, `obj` or `graph_name` cannot be
        [`BNodes`][rdflib.term.BNode].

    Parameters:
        subj: Subject of the statement to filter by, or `None` to match all.
        pred: Predicate of the statement to filter by, or `None` to match all.
        obj: Object of the statement to filter by, or `None` to match all.
        graph_name: Graph name(s) to restrict to.

            The default value `None` queries all graphs.

            To query just the default graph, use
            [`DATASET_DEFAULT_GRAPH_ID`][rdflib.graph.DATASET_DEFAULT_GRAPH_ID].
    """
    validate_no_bnodes(subj, pred, obj, graph_name)
    params: dict[str, str] = {}
    build_context_param(params, graph_name)
    build_spo_param(params, subj, pred, obj)

    response = self.http_client.delete(
        f"/repositories/{self.identifier}/statements",
        params=params,
    )
    response.raise_for_status()

get 

get(subj: SubjectType = None, pred: PredicateType = None, obj: ObjectType = None, graph_name: URIRef | Iterable[URIRef] | str | None = None, infer: bool = True, content_type: str | None = None) -> Graph | Dataset

Get RDF statements from the repository matching the filtering parameters.

Note

The terms for subj, pred, obj or graph_name cannot be BNodes.

Parameters:

  • subj

    (SubjectType, default: None ) –

    Subject of the statement to filter by, or None to match all.

  • pred

    (PredicateType, default: None ) –

    Predicate of the statement to filter by, or None to match all.

  • obj

    (ObjectType, default: None ) –

    Object of the statement to filter by, or None to match all.

  • graph_name

    (URIRef | Iterable[URIRef] | str | None, default: None ) –

    Graph name(s) to restrict to.

    The default value None queries all graphs.

    To query just the default graph, use DATASET_DEFAULT_GRAPH_ID.

  • infer

    (bool, default: True ) –

    Specifies whether inferred statements should be included in the result.

  • content_type

    (str | None, default: None ) –

    The content type of the response. A triple-based format returns a Graph, while a quad-based format returns a Dataset.

Returns:

Source code in rdflib/contrib/rdf4j/client.py 
550
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
def get(
    self,
    subj: SubjectType = None,
    pred: PredicateType = None,
    obj: ObjectType = None,
    graph_name: URIRef | Iterable[URIRef] | str | None = None,
    infer: bool = True,
    content_type: str | None = None,
) -> Graph | Dataset:
    """Get RDF statements from the repository matching the filtering parameters.

    !!! Note
        The terms for `subj`, `pred`, `obj` or `graph_name` cannot be
        [`BNodes`][rdflib.term.BNode].

    Parameters:
        subj: Subject of the statement to filter by, or `None` to match all.
        pred: Predicate of the statement to filter by, or `None` to match all.
        obj: Object of the statement to filter by, or `None` to match all.
        graph_name: Graph name(s) to restrict to.

            The default value `None` queries all graphs.

            To query just the default graph, use
            [`DATASET_DEFAULT_GRAPH_ID`][rdflib.graph.DATASET_DEFAULT_GRAPH_ID].

        infer: Specifies whether inferred statements should be included in the
            result.
        content_type: The content type of the response.
            A triple-based format returns a [Graph][rdflib.graph.Graph], while a
            quad-based format returns a [`Dataset`][rdflib.graph.Dataset].

    Returns:
        A [`Graph`][rdflib.graph.Graph] or [`Dataset`][rdflib.graph.Dataset] object
            with the repository namespace prefixes bound to it.
    """
    validate_no_bnodes(subj, pred, obj, graph_name)
    if content_type is None:
        content_type = "application/n-quads"
    headers = {"Accept": content_type}
    params: dict[str, str] = {}
    build_context_param(params, graph_name)
    build_spo_param(params, subj, pred, obj)
    build_infer_param(params, infer=infer)

    response = self.http_client.get(
        f"/repositories/{self.identifier}/statements",
        headers=headers,
        params=params,
    )
    response.raise_for_status()
    triple_formats = [
        "application/n-triples",
        "text/turtle",
        "application/rdf+xml",
    ]
    try:
        if content_type in triple_formats:
            retval = Graph().parse(data=response.text, format=content_type)
        else:
            retval = Dataset().parse(data=response.text, format=content_type)
        for result in self.namespaces.list():
            retval.bind(result.prefix, result.namespace, replace=True)
        return retval
    except Exception as err:
        raise RDFLibParserError(f"Error parsing RDF: {err}") from err

graph_names 

graph_names() -> list[IdentifiedNode]

Get a list of all graph names in the repository.

Returns:

Raises:

Source code in rdflib/contrib/rdf4j/client.py 
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
def graph_names(self) -> list[IdentifiedNode]:
    """Get a list of all graph names in the repository.

    Returns:
        A list of graph names.

    Raises:
        RepositoryResponseFormatError: Fails to parse the repository graph names.
    """
    headers = {
        "Accept": "application/sparql-results+json",
    }
    response = self.http_client.get(
        f"/repositories/{self.identifier}/contexts", headers=headers
    )
    response.raise_for_status()
    try:
        values: list[IdentifiedNode] = []
        for row in response.json()["results"]["bindings"]:
            value = row["contextID"]["value"]
            value_type = row["contextID"]["type"]
            if value_type == "uri":
                values.append(URIRef(value))
            elif value_type == "bnode":
                values.append(BNode(value))
            else:
                raise ValueError(f"Invalid graph name type: {value_type}")
        return values
    except Exception as err:
        raise RepositoryResponseFormatError(
            f"Failed to parse repository graph names: {err}"
        ) from err

health 

health() -> bool

Repository health check.

Returns:

  • bool ( bool ) –

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

Raises:

Source code in rdflib/contrib/rdf4j/client.py 
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
def health(self) -> bool:
    """Repository health check.

    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.
    """
    headers = {
        "Content-Type": "application/sparql-query",
        "Accept": "application/sparql-results+json",
    }
    try:
        response = self.http_client.post(
            f"/repositories/{self._identifier}", headers=headers, content="ASK {}"
        )
        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}"
        )

overwrite 

overwrite(data: str | bytes | BinaryIO | Graph | Dataset, graph_name: URIRef | Iterable[URIRef] | str | None = None, base_uri: str | None = None, content_type: str | None = None)

Upload and overwrite statements in the repository.

Parameters:

  • data

    (str | bytes | BinaryIO | Graph | Dataset) –

    The RDF data to upload.

  • graph_name

    (URIRef | Iterable[URIRef] | str | None, default: None ) –

    Graph name(s) to restrict to.

    The default value None applies to all graphs.

    To apply to just the default graph, use DATASET_DEFAULT_GRAPH_ID.

  • base_uri

    (str | None, default: None ) –

    The base URI to resolve against for any relative URIs in the data.

  • content_type

    (str | None, default: None ) –

    The content type of the data. Defaults to application/n-quads when the value is None.

Source code in rdflib/contrib/rdf4j/client.py 
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
def overwrite(
    self,
    data: str | bytes | BinaryIO | Graph | Dataset,
    graph_name: URIRef | Iterable[URIRef] | str | None = None,
    base_uri: str | None = None,
    content_type: str | None = None,
):
    """Upload and overwrite statements in the repository.

    Parameters:
        data: The RDF data to upload.
        graph_name: Graph name(s) to restrict to.

            The default value `None` applies to all graphs.

            To apply to just the default graph, use
            [`DATASET_DEFAULT_GRAPH_ID`][rdflib.graph.DATASET_DEFAULT_GRAPH_ID].

        base_uri: The base URI to resolve against for any relative URIs in the data.
        content_type: The content type of the data. Defaults to
            `application/n-quads` when the value is `None`.
    """
    stream, should_close = rdf_payload_to_stream(data)
    validate_graph_name(graph_name)
    try:
        headers = {"Content-Type": content_type or "application/n-quads"}
        params: dict[str, str] = {}
        build_context_param(params, graph_name)
        if base_uri is not None:
            params["baseURI"] = base_uri
        response = self.http_client.put(
            f"/repositories/{self.identifier}/statements",
            headers=headers,
            params=params,
            content=stream,
        )
        response.raise_for_status()
    finally:
        if should_close:
            stream.close()

query 

query(query: str, **kwargs)

Execute a SPARQL query against the repository.

Note

A POST request is used by default. If any keyword arguments are provided, a GET request is used instead, and the arguments are passed as query parameters.

Parameters:

  • query

    (str) –

    The SPARQL query to execute.

  • **kwargs

    –

    Additional keyword arguments to include as query parameters in the request. See RDF4J REST API - Execute SPARQL query for the list of supported query parameters.

Source code in rdflib/contrib/rdf4j/client.py 
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
def query(self, query: str, **kwargs):
    """Execute a SPARQL query against the repository.

    !!! note
        A POST request is used by default. If any keyword arguments are provided,
        a GET request is used instead, and the arguments are passed as query parameters.

    Parameters:
        query: The SPARQL query to execute.
        **kwargs: Additional keyword arguments to include as query parameters
            in the request. See
            [RDF4J REST API - Execute SPARQL query](https://rdf4j.org/documentation/reference/rest-api/#tag/SPARQL/paths/~1repositories~1%7BrepositoryID%7D/get)
            for the list of supported query parameters.
    """
    headers = {"Content-Type": "application/sparql-query"}
    build_sparql_query_accept_header(query, headers)

    if not kwargs:
        response = self.http_client.post(
            f"/repositories/{self.identifier}", headers=headers, content=query
        )
    else:
        response = self.http_client.get(
            f"/repositories/{self.identifier}",
            headers=headers,
            params={"query": query, **kwargs},
        )
    response.raise_for_status()
    try:
        return Result.parse(
            io.BytesIO(response.content),
            content_type=response.headers["Content-Type"].split(";")[0],
        )
    except KeyError as err:
        raise RDFLibParserError(
            f"Failed to parse SPARQL query result {response.headers.get('Content-Type')}: {err}"
        ) from err

size 

size(graph_name: URIRef | Iterable[URIRef] | str | None = None) -> int

The number of statements in the repository or in the specified graph name.

Parameters:

  • graph_name

    (URIRef | Iterable[URIRef] | str | None, default: None ) –

    Graph name(s) to restrict to.

    The default value None queries all graphs.

    To query just the default graph, use DATASET_DEFAULT_GRAPH_ID.

Returns:

  • int –

    The number of statements.

Raises:

Source code in rdflib/contrib/rdf4j/client.py 
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
def size(self, graph_name: URIRef | Iterable[URIRef] | str | None = None) -> int:
    """The number of statements in the repository or in the specified graph name.

    Parameters:
        graph_name: Graph name(s) to restrict to.

            The default value `None` queries all graphs.

            To query just the default graph, use
            [`DATASET_DEFAULT_GRAPH_ID`][rdflib.graph.DATASET_DEFAULT_GRAPH_ID].

    Returns:
        The number of statements.

    Raises:
        RepositoryResponseFormatError: Fails to parse the repository size.
    """
    validate_graph_name(graph_name)
    params: dict[str, str] = {}
    build_context_param(params, graph_name)
    response = self.http_client.get(
        f"/repositories/{self.identifier}/size", params=params
    )
    response.raise_for_status()
    return self._to_size(response.text)

transaction 

transaction()

Create a new transaction for the repository.

Warning

Transaction instances are not thread-safe. Do not share a single Transaction instance across multiple threads. Each thread should create its own transaction, or use appropriate synchronization if sharing is required.

Source code in rdflib/contrib/rdf4j/client.py 
724
725
726
727
728
729
730
731
732
733
734
735
736
@contextlib.contextmanager
def transaction(self):
    """Create a new transaction for the repository.

    !!! warning

    Transaction instances are not thread-safe. Do not share a single
    Transaction instance across multiple threads. Each thread should create
    its own transaction, or use appropriate synchronization if sharing is
    required.
    """
    with Transaction.create(self) as txn:
        yield txn

update 

update(query: str)

Execute a SPARQL update operation on the repository.

Parameters:

  • query

    (str) –

    The SPARQL update query to execute.

Source code in rdflib/contrib/rdf4j/client.py 
503
504
505
506
507
508
509
510
511
512
513
514
515
def update(self, query: str):
    """Execute a SPARQL update operation on the repository.

    Parameters:
        query: The SPARQL update query to execute.
    """
    headers = {"Content-Type": "application/sparql-update"}
    response = self.http_client.post(
        f"/repositories/{self.identifier}/statements",
        headers=headers,
        content=query,
    )
    response.raise_for_status()

upload 

upload(data: str | bytes | BinaryIO | Graph | Dataset, base_uri: str | None = None, content_type: str | None = None)

Upload and append statements to the repository.

Parameters:

  • data

    (str | bytes | BinaryIO | Graph | Dataset) –

    The RDF data to upload.

  • base_uri

    (str | None, default: None ) –

    The base URI to resolve against for any relative URIs in the data.

  • content_type

    (str | None, default: None ) –

    The content type of the data. Defaults to application/n-quads when the value is None.

Source code in rdflib/contrib/rdf4j/client.py 
617
618
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
def upload(
    self,
    data: str | bytes | BinaryIO | Graph | Dataset,
    base_uri: str | None = None,
    content_type: str | None = None,
):
    """Upload and append statements to the repository.

    Parameters:
        data: The RDF data to upload.
        base_uri: The base URI to resolve against for any relative URIs in the data.
        content_type: The content type of the data. Defaults to
            `application/n-quads` when the value is `None`.
    """
    stream, should_close = rdf_payload_to_stream(data)
    try:
        headers = {"Content-Type": content_type or "application/n-quads"}
        params = {}
        if base_uri is not None:
            params["baseURI"] = base_uri
        response = self.http_client.post(
            f"/repositories/{self.identifier}/statements",
            headers=headers,
            params=params,
            content=stream,
        )
        response.raise_for_status()
    finally:
        if should_close:
            stream.close()

RepositoryListingResult dataclass 

RepositoryListingResult(identifier: str, uri: str, readable: bool, writable: bool, title: str | None = None)

RDF4J repository listing result.

Parameters:

  • identifier

    (str) –

    Repository identifier.

  • uri

    (str) –

    Repository URI.

  • readable

    (bool) –

    Whether the repository is readable by the client.

  • writable

    (bool) –

    Whether the repository is writable by the client.

  • title

    (str | None, default: None ) –

    Repository title.

Attributes:

identifier instance-attribute 

identifier: str

readable instance-attribute 

readable: bool

title class-attribute instance-attribute 

title: str | None = None

uri instance-attribute 

uri: str

writable instance-attribute 

writable: bool

RepositoryManager 

RepositoryManager(http_client: Client)

A client to manage server-level repository operations.

Parameters:

  • http_client

    (Client) –

    The httpx.Client instance.

Methods:

  • create –

    Create a new repository.

  • delete –

    Delete a repository.

  • get –

    Get a repository by ID.

  • list –

    List all available repositories.

Attributes:

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

http_client property 

http_client

create 

create(repository_id: str, data: str, content_type: str = 'text/turtle') -> Repository

Create a new repository.

Parameters:

  • repository_id

    (str) –

    The identifier of the repository.

  • data

    (str) –

    The repository configuration in RDF.

  • content_type

    (str, default: 'text/turtle' ) –

    The repository configuration content type.

Raises:

Source code in rdflib/contrib/rdf4j/client.py 
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
def create(
    self, repository_id: str, data: str, content_type: str = "text/turtle"
) -> Repository:
    """Create a new repository.

    Parameters:
        repository_id: The identifier of the repository.
        data: The repository configuration in RDF.
        content_type: The repository configuration content type.

    Raises:
        RepositoryAlreadyExistsError: If the repository already exists.
        RepositoryNotHealthyError: If the repository is not healthy.
    """
    try:
        headers = {"Content-Type": content_type}
        response = self.http_client.put(
            f"/repositories/{repository_id}", headers=headers, content=data
        )
        response.raise_for_status()
        return self.get(repository_id)
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 409:
            raise RepositoryAlreadyExistsError(
                f"Repository {repository_id} already exists."
            )
        raise

delete 

delete(repository_id: str) -> None

Delete a repository.

Parameters:

  • repository_id

    (str) –

    The identifier of the repository.

Raises:

Source code in rdflib/contrib/rdf4j/client.py 
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
def delete(self, repository_id: str) -> None:
    """Delete a repository.

    Parameters:
        repository_id: The identifier of the repository.

    Raises:
        RepositoryNotFoundError: If the repository is not found.
        RepositoryError: If the repository is not deleted successfully.
    """
    try:
        response = self.http_client.delete(f"/repositories/{repository_id}")
        response.raise_for_status()
        if response.status_code != 204:
            raise RepositoryError(
                f"Unexpected response status code when deleting repository {repository_id}: {response.status_code} - {response.text.strip()}"
            )
    except httpx.HTTPStatusError as err:
        if err.response.status_code == 404:
            raise RepositoryNotFoundError(f"Repository {repository_id} not found.")
        raise

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/rdf4j/client.py 
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
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 = Repository(repository_id, self.http_client)
    repo.health()
    return repo

list 

list() -> list[RepositoryListingResult]

List all available repositories.

Returns:

Raises:

Source code in rdflib/contrib/rdf4j/client.py 
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
1108
1109
1110
def list(self) -> list[RepositoryListingResult]:
    """List all available repositories.

    Returns:
        list[RepositoryListingResult]: List of repository results.

    Raises:
        RepositoryResponseFormatError: If the response format is unrecognized.
    """
    headers = {
        "Accept": "application/sparql-results+json",
    }
    response = self.http_client.get("/repositories", headers=headers)
    response.raise_for_status()

    try:
        data = response.json()
        results = data["results"]["bindings"]
        return [
            RepositoryListingResult(
                identifier=repo["id"]["value"],
                uri=repo["uri"]["value"],
                readable=repo["readable"]["value"],
                writable=repo["writable"]["value"],
                title=repo.get("title", {}).get("value"),
            )
            for repo in results
        ]
    except (KeyError, ValueError) as err:
        raise RepositoryResponseFormatError(f"Unrecognised response format: {err}")

Transaction 

Transaction(repo: Repository, url: str)

An RDF4J transaction.

Warning

Transaction instances are not thread-safe. Do not share a single Transaction instance across multiple threads. Each thread should create its own transaction, or use appropriate synchronization if sharing is required.

Parameters:

Methods:

  • __enter__ –
  • __exit__ –
  • commit –

    Commit the transaction.

  • create –

    Create a new transaction for the repository.

  • delete –

    Delete statements from the repository.

  • get –

    Get RDF statements from the repository matching the filtering parameters.

  • ping –

    Ping the transaction.

  • query –

    Execute a SPARQL query against the repository.

  • rollback –

    Roll back the transaction.

  • size –

    The number of statements in the repository or in the specified graph name.

  • update –

    Execute a SPARQL update operation on the repository.

  • upload –

    Upload and append statements to the repository.

Attributes:

  • is_closed (bool) –

    Whether the transaction is closed.

  • repo –

    The repository instance.

  • url –

    The transaction URL.

Source code in rdflib/contrib/rdf4j/client.py 
753
754
755
756
def __init__(self, repo: Repository, url: str):
    self._repo = repo
    self._url: str = url
    self._closed: bool = False

is_closed property 

is_closed: bool

Whether the transaction is closed.

repo property 

repo

The repository instance.

url property 

url

The transaction URL.

__enter__ 

__enter__()
Source code in rdflib/contrib/rdf4j/client.py 
758
759
def __enter__(self):
    return self

__exit__ 

__exit__(exc_type, exc_val, exc_tb)
Source code in rdflib/contrib/rdf4j/client.py 
761
762
763
764
765
766
767
768
769
770
771
772
def __exit__(self, exc_type, exc_val, exc_tb):
    if not self.is_closed:
        if exc_type is None:
            self.commit()
        else:
            try:
                self.rollback()
            except Exception:
                pass

    # Propagate errors.
    return False

commit 

commit()

Commit the transaction.

Raises:

Source code in rdflib/contrib/rdf4j/client.py 
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
def commit(self):
    """Commit the transaction.

    Raises:
        TransactionCommitError: If the transaction commit fails.
        TransactionClosedError: If the transaction is closed.
    """
    self._raise_for_closed()
    params = {"action": "COMMIT"}
    response = self.repo.http_client.put(self.url, params=params)
    if response.status_code != 200:
        raise TransactionCommitError(
            f"Transaction commit failed: {response.status_code} - {response.text}"
        )
    self._closed = True

create classmethod 

create(repo: Repository) -> Transaction

Create a new transaction for the repository.

Parameters:

Returns:

Source code in rdflib/contrib/rdf4j/client.py 
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
@classmethod
def create(cls, repo: Repository) -> Transaction:
    """Create a new transaction for the repository.

    Parameters:
        repo: The repository instance.

    Returns:
        A new Transaction instance.
    """
    response = repo.http_client.post(
        f"/repositories/{repo.identifier}/transactions"
    )
    response.raise_for_status()
    url = response.headers["Location"]
    return cls(repo, url)

delete 

delete(data: str | bytes | BinaryIO | Graph | Dataset, base_uri: str | None = None, content_type: str | None = None) -> None

Delete statements from the repository.

Note

This function operates differently to Repository.delete as it does not use filter parameters. Instead, it expects a data payload. See the notes from graphdb.js#Deleting for more information.

Parameters:

  • data

    (str | bytes | BinaryIO | Graph | Dataset) –

    The RDF data to upload.

  • base_uri

    (str | None, default: None ) –

    The base URI to resolve against for any relative URIs in the data.

  • content_type

    (str | None, default: None ) –

    The content type of the data. Defaults to application/n-quads when the value is None.

Source code in rdflib/contrib/rdf4j/client.py 
1026
1027
1028
1029
1030
1031
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
def delete(
    self,
    data: str | bytes | BinaryIO | Graph | Dataset,
    base_uri: str | None = None,
    content_type: str | None = None,
) -> None:
    """Delete statements from the repository.

    !!! Note
        This function operates differently to
        [`Repository.delete`][rdflib.contrib.rdf4j.client.Repository.delete]
        as it does not use filter parameters. Instead, it expects a data payload.
        See the notes from
        [graphdb.js#Deleting](https://github.com/Ontotext-AD/graphdb.js?tab=readme-ov-file#deleting-1)
        for more information.

    Parameters:
        data: The RDF data to upload.
        base_uri: The base URI to resolve against for any relative URIs in the data.
        content_type: The content type of the data. Defaults to
            `application/n-quads` when the value is `None`.
    """
    self._raise_for_closed()
    params: dict[str, str] = {"action": "DELETE"}
    stream, should_close = rdf_payload_to_stream(data)
    headers = {"Content-Type": content_type or "application/n-quads"}
    if base_uri is not None:
        params["baseURI"] = base_uri
    try:
        response = self.repo.http_client.put(
            self.url,
            headers=headers,
            params=params,
            content=stream,
        )
        response.raise_for_status()
    finally:
        if should_close:
            stream.close()

get 

get(subj: SubjectType = None, pred: PredicateType = None, obj: ObjectType = None, graph_name: URIRef | Iterable[URIRef] | str | None = None, infer: bool = True, content_type: str | None = None) -> Graph | Dataset

Get RDF statements from the repository matching the filtering parameters.

Note

The terms for subj, pred, obj or graph_name cannot be BNodes.

Parameters:

  • subj

    (SubjectType, default: None ) –

    Subject of the statement to filter by, or None to match all.

  • pred

    (PredicateType, default: None ) –

    Predicate of the statement to filter by, or None to match all.

  • obj

    (ObjectType, default: None ) –

    Object of the statement to filter by, or None to match all.

  • graph_name

    (URIRef | Iterable[URIRef] | str | None, default: None ) –

    Graph name(s) to restrict to.

    The default value None queries all graphs.

    To query just the default graph, use DATASET_DEFAULT_GRAPH_ID.

  • infer

    (bool, default: True ) –

    Specifies whether inferred statements should be included in the result.

  • content_type

    (str | None, default: None ) –

    The content type of the response. A triple-based format returns a Graph, while a quad-based format returns a Dataset.

Returns:

Source code in rdflib/contrib/rdf4j/client.py 
 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
 986
 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
def get(
    self,
    subj: SubjectType = None,
    pred: PredicateType = None,
    obj: ObjectType = None,
    graph_name: URIRef | Iterable[URIRef] | str | None = None,
    infer: bool = True,
    content_type: str | None = None,
) -> Graph | Dataset:
    """Get RDF statements from the repository matching the filtering parameters.

    !!! Note
        The terms for `subj`, `pred`, `obj` or `graph_name` cannot be
        [`BNodes`][rdflib.term.BNode].

    Parameters:
        subj: Subject of the statement to filter by, or `None` to match all.
        pred: Predicate of the statement to filter by, or `None` to match all.
        obj: Object of the statement to filter by, or `None` to match all.
        graph_name: Graph name(s) to restrict to.

            The default value `None` queries all graphs.

            To query just the default graph, use
            [`DATASET_DEFAULT_GRAPH_ID`][rdflib.graph.DATASET_DEFAULT_GRAPH_ID].

        infer: Specifies whether inferred statements should be included in the
            result.
        content_type: The content type of the response.
            A triple-based format returns a [Graph][rdflib.graph.Graph], while a
            quad-based format returns a [`Dataset`][rdflib.graph.Dataset].

    Returns:
        A [`Graph`][rdflib.graph.Graph] or [`Dataset`][rdflib.graph.Dataset] object
            with the repository namespace prefixes bound to it.
    """
    self._raise_for_closed()
    validate_no_bnodes(subj, pred, obj, graph_name)
    if content_type is None:
        content_type = "application/n-quads"
    headers = {"Accept": content_type}
    params: dict[str, str] = {"action": "GET"}
    build_context_param(params, graph_name)
    build_spo_param(params, subj, pred, obj)
    build_infer_param(params, infer=infer)

    response = self.repo.http_client.put(
        self.url,
        headers=headers,
        params=params,
    )
    response.raise_for_status()
    triple_formats = [
        "application/n-triples",
        "text/turtle",
        "application/rdf+xml",
    ]
    try:
        if content_type in triple_formats:
            retval = Graph().parse(data=response.text, format=content_type)
        else:
            retval = Dataset().parse(data=response.text, format=content_type)
        for result in self.repo.namespaces.list():
            retval.bind(result.prefix, result.namespace, replace=True)
        return retval
    except Exception as err:
        raise RDFLibParserError(f"Error parsing RDF: {err}") from err

ping 

ping()

Ping the transaction.

Raises:

  • RepositoryTransactionPingError –

    If the transaction ping fails.

  • TransactionClosedError –

    If the transaction is closed.

Source code in rdflib/contrib/rdf4j/client.py 
841
842
843
844
845
846
847
848
849
850
851
852
853
854
def ping(self):
    """Ping the transaction.

    Raises:
        RepositoryTransactionPingError: If the transaction ping fails.
        TransactionClosedError: If the transaction is closed.
    """
    self._raise_for_closed()
    params = {"action": "PING"}
    response = self.repo.http_client.put(self.url, params=params)
    if response.status_code != 200:
        raise TransactionPingError(
            f"Transaction ping failed: {response.status_code} - {response.text}"
        )

query 

query(query: str, **kwargs)

Execute a SPARQL query against the repository.

Parameters:

  • query

    (str) –

    The SPARQL query to execute.

  • **kwargs

    –

    Additional keyword arguments to include as query parameters in the request. See RDF4J REST API - Execute SPARQL query for the list of supported query parameters.

Source code in rdflib/contrib/rdf4j/client.py 
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
def query(self, query: str, **kwargs):
    """Execute a SPARQL query against the repository.

    Parameters:
        query: The SPARQL query to execute.
        **kwargs: Additional keyword arguments to include as query parameters
            in the request. See
            [RDF4J REST API - Execute SPARQL query](https://rdf4j.org/documentation/reference/rest-api/#tag/SPARQL/paths/~1repositories~1%7BrepositoryID%7D/get)
            for the list of supported query parameters.
    """
    self._raise_for_closed()
    headers: dict[str, str] = {}
    build_sparql_query_accept_header(query, headers)
    params = {"action": "QUERY", "query": query}
    response = self.repo.http_client.put(
        self.url, headers=headers, params={**params, **kwargs}
    )
    response.raise_for_status()
    try:
        return Result.parse(
            io.BytesIO(response.content),
            content_type=response.headers["Content-Type"].split(";")[0],
        )
    except KeyError as err:
        raise RDFLibParserError(
            f"Failed to parse SPARQL query result {response.headers.get('Content-Type')}: {err}"
        ) from err

rollback 

rollback()

Roll back the transaction.

Raises:

Source code in rdflib/contrib/rdf4j/client.py 
826
827
828
829
830
831
832
833
834
835
836
837
838
839
def rollback(self):
    """Roll back the transaction.

    Raises:
        TransactionRollbackError: If the transaction rollback fails.
        TransactionClosedError: If the transaction is closed.
    """
    self._raise_for_closed()
    response = self.repo.http_client.delete(self.url)
    if response.status_code != 204:
        raise TransactionRollbackError(
            f"Transaction rollback failed: {response.status_code} - {response.text}"
        )
    self._closed = True

size 

size(graph_name: URIRef | Iterable[URIRef] | str | None = None)

The number of statements in the repository or in the specified graph name.

Parameters:

  • graph_name

    (URIRef | Iterable[URIRef] | str | None, default: None ) –

    Graph name(s) to restrict to.

    The default value None queries all graphs.

    To query just the default graph, use DATASET_DEFAULT_GRAPH_ID.

Returns:

  • –

    The number of statements.

Raises:

Source code in rdflib/contrib/rdf4j/client.py 
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
def size(self, graph_name: URIRef | Iterable[URIRef] | str | None = None):
    """The number of statements in the repository or in the specified graph name.

    Parameters:
        graph_name: Graph name(s) to restrict to.

            The default value `None` queries all graphs.

            To query just the default graph, use
            [`DATASET_DEFAULT_GRAPH_ID`][rdflib.graph.DATASET_DEFAULT_GRAPH_ID].

    Returns:
        The number of statements.

    Raises:
        RepositoryResponseFormatError: Fails to parse the repository size.
    """
    self._raise_for_closed()
    validate_graph_name(graph_name)
    params = {"action": "SIZE"}
    build_context_param(params, graph_name)
    response = self.repo.http_client.put(self.url, params=params)
    response.raise_for_status()
    return self.repo._to_size(response.text)

update 

update(query: str, **kwargs)

Execute a SPARQL update operation on the repository.

Parameters:

Source code in rdflib/contrib/rdf4j/client.py 
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
def update(self, query: str, **kwargs):
    """Execute a SPARQL update operation on the repository.

    Parameters:
        query: The SPARQL update query to execute.
        **kwargs: Additional keyword arguments to include as query parameters
            See [RDF4J REST API - Execute a transaction action](https://rdf4j.org/documentation/reference/rest-api/#tag/Transactions/paths/~1repositories~1%7BrepositoryID%7D~1transactions~1%7BtransactionID%7D/put)
            for the list of supported query parameters.
    """
    self._raise_for_closed()
    params = {"action": "UPDATE", "update": query}
    response = self.repo.http_client.put(
        self.url,
        params={**params, **kwargs},
    )
    response.raise_for_status()

upload 

upload(data: str | bytes | BinaryIO | Graph | Dataset, base_uri: str | None = None, content_type: str | None = None)

Upload and append statements to the repository.

Parameters:

  • data

    (str | bytes | BinaryIO | Graph | Dataset) –

    The RDF data to upload.

  • base_uri

    (str | None, default: None ) –

    The base URI to resolve against for any relative URIs in the data.

  • content_type

    (str | None, default: None ) –

    The content type of the data. Defaults to application/n-quads when the value is None.

Source code in rdflib/contrib/rdf4j/client.py 
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
def upload(
    self,
    data: str | bytes | BinaryIO | Graph | Dataset,
    base_uri: str | None = None,
    content_type: str | None = None,
):
    """Upload and append statements to the repository.

    Parameters:
        data: The RDF data to upload.
        base_uri: The base URI to resolve against for any relative URIs in the data.
        content_type: The content type of the data. Defaults to
            `application/n-quads` when the value is `None`.
    """
    self._raise_for_closed()
    stream, should_close = rdf_payload_to_stream(data)
    headers = {"Content-Type": content_type or "application/n-quads"}
    params = {"action": "ADD"}
    if base_uri is not None:
        params["baseURI"] = base_uri
    try:
        response = self.repo.http_client.put(
            self.url,
            headers=headers,
            params=params,
            content=stream,
        )
        response.raise_for_status()
    finally:
        if should_close:
            stream.close()