SPARQL¶
Validate query and update syntax¶
Use kurra.sparql.validate(q) to check SPARQL syntax without executing a query or update. The q argument accepts
SPARQL text, a pathlib.Path, or a string containing a file path, matching the query input used by query().
from kurra.sparql import validate
validate("SELECT * WHERE { ?s ?p ?o }")
validate("INSERT DATA { <urn:s> <urn:p> <urn:o> }")
validate("query.sparql")
The function returns None on success. Invalid syntax raises pyparsing.ParseBaseException, whose lineno, col,
and msg attributes describe the error. Validation uses RDFLib's parseQuery() and, if needed, parseUpdate().
It checks syntax; it does not resolve undeclared prefixes or check endpoint capabilities.
Remote queries and updates are validated before they are sent to an endpoint, after supplied namespaces are added. Local queries and updates use RDFLib's existing parsing during execution, avoiding an additional validation pass.
Python reference¶
kurra.sparql ¶
SPARQL query functions.
validate ¶
Validate SPARQL query or update syntax without executing it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
q
|
str | Path
|
SPARQL text, or a path to a file containing it. |
required |
Raises:
| Type | Description |
|---|---|
ParseBaseException
|
If neither the query nor update parser accepts the text. |
Source code in kurra/sparql.py
query ¶
query(p: Path | str | Graph | Dataset, q: str | Path, *, namespaces: dict[str, str] | None, http_client: Client | None, return_format: Literal['original'] = 'original', return_bindings_only: bool = False) -> str
query(p: Path | str | Graph | Dataset, q: str | Path, namespaces: dict[str, str] | None = None, http_client: Client | None = None, return_format: Literal['original', 'python', 'dataframe'] = 'original', return_bindings_only: bool = False) -> str | Graph | dict | DataFrame
Run a SPARQL query or update against a file, RDF Graph/Dataset, or SPARQL endpoint.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
p
|
Path | str | Graph | Dataset
|
A local file path, SPARQL endpoint URL, RDF string, Graph, or Dataset. |
required |
q
|
str | Path
|
The SPARQL query or update, as a string or a path to a file containing one. |
required |
namespaces
|
dict[str, str] | None
|
Namespace prefixes to add to |
None
|
http_client
|
Client | None
|
An optional HTTPX client to contain credentials if needed to access a SPARQL endpoint when |
None
|
return_format
|
Literal['original', 'python', 'dataframe']
|
|
'original'
|
return_bindings_only
|
bool
|
If True, return just the result bindings rather than the full SPARQL results structure. |
False
|
Returns:
| Type | Description |
|---|---|
str | Graph | dict | DataFrame
|
The query result, in the requested |
Raises:
| Type | Description |
|---|---|
ValueError
|
If |
NotImplementedError
|
If a DROP update targets anything other than a Dataset, or an update targets a Dataset directly. |
Source code in kurra/sparql.py
88 89 90 91 92 93 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 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |