prograph 1.3.3__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (237) hide show
  1. prograph/__init__.py +36 -0
  2. prograph/__main__.py +5 -0
  3. prograph/_version.py +375 -0
  4. prograph/cli/__init__.py +1 -0
  5. prograph/cli/_iri_utils.py +124 -0
  6. prograph/cli/emit_genie_space.py +107 -0
  7. prograph/cli/generate_views.py +140 -0
  8. prograph/cli/main.py +420 -0
  9. prograph/cli/schema_inferrer.py +746 -0
  10. prograph/cli/ttl_loader.py +289 -0
  11. prograph/cli/upload_genie_space.py +84 -0
  12. prograph/config/__init__.py +27 -0
  13. prograph/config/yaml_config.py +848 -0
  14. prograph/demos/__init__.py +14 -0
  15. prograph/demos/turbofan/README.md +74 -0
  16. prograph/demos/turbofan/SCENARIO.md +209 -0
  17. prograph/demos/turbofan/__init__.py +75 -0
  18. prograph/demos/turbofan/create_tables.sql +206 -0
  19. prograph/demos/turbofan/data/engine-instances.ttl +1123 -0
  20. prograph/demos/turbofan/data/sensor-timeseries.csv +90 -0
  21. prograph/demos/turbofan/demo.py +162 -0
  22. prograph/demos/turbofan/genie_qa_notebook.py +434 -0
  23. prograph/demos/turbofan/graph.yaml +1098 -0
  24. prograph/demos/turbofan/instance_graph_demo.py +32 -0
  25. prograph/demos/turbofan/load.py +223 -0
  26. prograph/demos/turbofan/mapping.r2rml.ttl +991 -0
  27. prograph/demos/turbofan/ontology/engine-maintenance.ttl +606 -0
  28. prograph/demos/turbofan/payload-shapes.ttl +33 -0
  29. prograph/demos/turbofan/queries/example-queries.sparql +215 -0
  30. prograph/demos/turbofan/shapes.ttl +75 -0
  31. prograph/demos/turbofan/tables.py +106 -0
  32. prograph/demos/turbofan/turbofan_schema.py +393 -0
  33. prograph/demos/turbofan/validation_demo.py +153 -0
  34. prograph/describe.py +231 -0
  35. prograph/endpoint/__init__.py +12 -0
  36. prograph/endpoint/app.py +722 -0
  37. prograph/endpoint/cli.py +280 -0
  38. prograph/endpoint/credentials.py +240 -0
  39. prograph/endpoint/engines.py +418 -0
  40. prograph/endpoint/negotiate.py +101 -0
  41. prograph/endpoint/results.py +181 -0
  42. prograph/endpoint/service.py +31 -0
  43. prograph/engine.py +2718 -0
  44. prograph/execution.py +455 -0
  45. prograph/executors/__init__.py +6 -0
  46. prograph/executors/base.py +11 -0
  47. prograph/executors/databricks_sql_executor.py +51 -0
  48. prograph/executors/duckdb_executor.py +24 -0
  49. prograph/executors/mysql_executor.py +20 -0
  50. prograph/executors/oracle_executor.py +24 -0
  51. prograph/executors/pandas_executor.py +72 -0
  52. prograph/executors/postgresql_executor.py +35 -0
  53. prograph/executors/spark_executor.py +88 -0
  54. prograph/executors/sqlserver_executor.py +35 -0
  55. prograph/extras/__init__.py +1 -0
  56. prograph/extras/graphql/__init__.py +33 -0
  57. prograph/extras/graphql/execute.py +25 -0
  58. prograph/extras/graphql/schema.py +314 -0
  59. prograph/extras/instance_graph.py +559 -0
  60. prograph/genie/__init__.py +83 -0
  61. prograph/genie/databricks_uploader.py +306 -0
  62. prograph/genie/deploy.py +393 -0
  63. prograph/genie/formats.py +414 -0
  64. prograph/genie/instruction_generator.py +375 -0
  65. prograph/genie/sample_query_generator.py +256 -0
  66. prograph/genie/shacl_views.py +318 -0
  67. prograph/genie/space_emitter.py +329 -0
  68. prograph/genie/view_generator.py +628 -0
  69. prograph/genie/view_writer.py +172 -0
  70. prograph/graph/__init__.py +1 -0
  71. prograph/graph/ansi_session.py +348 -0
  72. prograph/graph/databricks_sql_graph.py +300 -0
  73. prograph/graph/drivers.py +143 -0
  74. prograph/graph/duckdb_graph.py +68 -0
  75. prograph/graph/mysql_graph.py +38 -0
  76. prograph/graph/oracle_graph.py +285 -0
  77. prograph/graph/pandas_graph.py +343 -0
  78. prograph/graph/postgresql_graph.py +644 -0
  79. prograph/graph/spark_graph.py +556 -0
  80. prograph/graph/sql_graph.py +83 -0
  81. prograph/graph/sqlserver_graph.py +72 -0
  82. prograph/hints.py +95 -0
  83. prograph/logging.py +550 -0
  84. prograph/mcp/__init__.py +29 -0
  85. prograph/mcp/__main__.py +180 -0
  86. prograph/mcp/bootstrap.py +98 -0
  87. prograph/mcp/server.py +601 -0
  88. prograph/mcp/sparql.py +397 -0
  89. prograph/mcp/tools.py +504 -0
  90. prograph/nlp/__init__.py +79 -0
  91. prograph/nlp/client.py +305 -0
  92. prograph/nlp/databricks_tools.py +369 -0
  93. prograph/nlp/graph_context.py +313 -0
  94. prograph/nlp/interface.py +652 -0
  95. prograph/nlp/prompts/__init__.py +19 -0
  96. prograph/nlp/prompts/examples.py +258 -0
  97. prograph/nlp/prompts/system.py +239 -0
  98. prograph/nlp/providers/__init__.py +14 -0
  99. prograph/nlp/providers/anthropic.py +274 -0
  100. prograph/nlp/providers/databricks.py +312 -0
  101. prograph/nlp/providers/openai.py +203 -0
  102. prograph/nlp/schema_context.py +78 -0
  103. prograph/ontology/__init__.py +53 -0
  104. prograph/ontology/alignment.py +542 -0
  105. prograph/ontology/hierarchy.py +310 -0
  106. prograph/ontology/imports.py +587 -0
  107. prograph/ontology/layer.py +991 -0
  108. prograph/ontology/skos.py +61 -0
  109. prograph/owl/__init__.py +27 -0
  110. prograph/owl/defined_classes.py +323 -0
  111. prograph/parameters.py +242 -0
  112. prograph/parser/__init__.py +1 -0
  113. prograph/parser/cypher/CypherLexer.py +836 -0
  114. prograph/parser/cypher/CypherListener.py +966 -0
  115. prograph/parser/cypher/CypherParser.py +10854 -0
  116. prograph/parser/cypher/CypherVisitor.py +543 -0
  117. prograph/parser/cypher/__init__.py +1 -0
  118. prograph/parser/sparql/SparqlLexer.py +801 -0
  119. prograph/parser/sparql/SparqlParser.py +10146 -0
  120. prograph/parser/sparql/SparqlParserListener.py +1056 -0
  121. prograph/parser/sparql/SparqlParserVisitor.py +593 -0
  122. prograph/parser/sparql/__init__.py +8 -0
  123. prograph/plan/__init__.py +3 -0
  124. prograph/plan/ir/__init__.py +1 -0
  125. prograph/plan/ir/casts.py +338 -0
  126. prograph/plan/ir/consistency.py +397 -0
  127. prograph/plan/ir/construct.py +90 -0
  128. prograph/plan/ir/cost.py +234 -0
  129. prograph/plan/ir/cypher_answer.py +1081 -0
  130. prograph/plan/ir/cypher_apoc.py +717 -0
  131. prograph/plan/ir/cypher_apoc_convert.py +505 -0
  132. prograph/plan/ir/cypher_apoc_date.py +845 -0
  133. prograph/plan/ir/cypher_apoc_map.py +496 -0
  134. prograph/plan/ir/cypher_apoc_meta.py +384 -0
  135. prograph/plan/ir/cypher_apoc_path.py +597 -0
  136. prograph/plan/ir/cypher_apoc_procedures.py +163 -0
  137. prograph/plan/ir/cypher_apoc_text.py +785 -0
  138. prograph/plan/ir/cypher_front.py +5474 -0
  139. prograph/plan/ir/cypher_functions.py +565 -0
  140. prograph/plan/ir/cypher_lists.py +935 -0
  141. prograph/plan/ir/cypher_maps.py +370 -0
  142. prograph/plan/ir/cypher_mixed.py +604 -0
  143. prograph/plan/ir/cypher_ontology.py +226 -0
  144. prograph/plan/ir/cypher_procedures.py +191 -0
  145. prograph/plan/ir/cypher_runtime_errors.py +107 -0
  146. prograph/plan/ir/cypher_temporal.py +1357 -0
  147. prograph/plan/ir/cypher_temporal_arith.py +339 -0
  148. prograph/plan/ir/cypher_values.py +546 -0
  149. prograph/plan/ir/cypher_write.py +612 -0
  150. prograph/plan/ir/dataset.py +643 -0
  151. prograph/plan/ir/dates.py +102 -0
  152. prograph/plan/ir/entry.py +992 -0
  153. prograph/plan/ir/expr.py +260 -0
  154. prograph/plan/ir/facts.py +1171 -0
  155. prograph/plan/ir/fresh.py +291 -0
  156. prograph/plan/ir/freshness.py +625 -0
  157. prograph/plan/ir/identity.py +797 -0
  158. prograph/plan/ir/java_datetime.py +265 -0
  159. prograph/plan/ir/java_regex.py +391 -0
  160. prograph/plan/ir/join_order.py +39 -0
  161. prograph/plan/ir/key_checks.py +433 -0
  162. prograph/plan/ir/keys.py +454 -0
  163. prograph/plan/ir/lower.py +5323 -0
  164. prograph/plan/ir/ops.py +619 -0
  165. prograph/plan/ir/owl_rl.py +1119 -0
  166. prograph/plan/ir/owl_rl_rules.py +725 -0
  167. prograph/plan/ir/profiles.py +694 -0
  168. prograph/plan/ir/ql.py +987 -0
  169. prograph/plan/ir/rdfs.py +342 -0
  170. prograph/plan/ir/rewrite.py +1782 -0
  171. prograph/plan/ir/saturate.py +339 -0
  172. prograph/plan/ir/semantics.py +103 -0
  173. prograph/plan/ir/slot.py +509 -0
  174. prograph/plan/ir/sparql_front.py +3418 -0
  175. prograph/plan/ir/strings.py +534 -0
  176. prograph/plan/ir/term_functions.py +274 -0
  177. prograph/plan/ir/terms.py +84 -0
  178. prograph/plan/ir/xpath_regex.py +264 -0
  179. prograph/plan/run_record.py +65 -0
  180. prograph/plan/sql/__init__.py +21 -0
  181. prograph/plan/sql/dialect.py +3726 -0
  182. prograph/plan/sql/mysql_serializer.py +103 -0
  183. prograph/plan/sql/names.py +65 -0
  184. prograph/plan/sql/oracle_serializer.py +306 -0
  185. prograph/plan/sql/pg_serializer.py +501 -0
  186. prograph/plan/sql/rel_algebra.py +781 -0
  187. prograph/plan/sql/sql_serializer.py +1419 -0
  188. prograph/plan/sql/sqlserver_serializer.py +603 -0
  189. prograph/provenance.py +222 -0
  190. prograph/r2rml/__init__.py +48 -0
  191. prograph/r2rml/catalog.py +259 -0
  192. prograph/r2rml/compile.py +372 -0
  193. prograph/r2rml/direct.py +140 -0
  194. prograph/r2rml/export.py +495 -0
  195. prograph/r2rml/model.py +180 -0
  196. prograph/r2rml/parser.py +546 -0
  197. prograph/r2rml/schema.py +120 -0
  198. prograph/read_only.py +122 -0
  199. prograph/results.py +157 -0
  200. prograph/rules/__init__.py +168 -0
  201. prograph/rules/__main__.py +32 -0
  202. prograph/schema/__init__.py +60 -0
  203. prograph/schema/change_set.py +50 -0
  204. prograph/schema/collations.py +198 -0
  205. prograph/schema/compile_schema.py +388 -0
  206. prograph/schema/context.py +845 -0
  207. prograph/schema/examples.py +234 -0
  208. prograph/schema/iri.py +817 -0
  209. prograph/schema/literals.py +94 -0
  210. prograph/schema/lpg_view.py +617 -0
  211. prograph/schema/mapping.py +1803 -0
  212. prograph/schema/maps_schema.py +40 -0
  213. prograph/schema/naming.py +77 -0
  214. prograph/schema/query_sources.py +59 -0
  215. prograph/schema/rows.py +215 -0
  216. prograph/schema/source_map.py +1103 -0
  217. prograph/schema/store_view.py +459 -0
  218. prograph/schema/types.py +569 -0
  219. prograph/schema/xsd.py +569 -0
  220. prograph/shacl/__init__.py +30 -0
  221. prograph/shacl/dqv.py +58 -0
  222. prograph/shacl/generate.py +255 -0
  223. prograph/shacl/report.py +138 -0
  224. prograph/shacl/validator.py +164 -0
  225. prograph/store.py +1737 -0
  226. prograph/utils/__init__.py +6 -0
  227. prograph/utils/exceptions.py +308 -0
  228. prograph/utils/helpers.py +126 -0
  229. prograph/warnings.py +46 -0
  230. prograph/writes.py +369 -0
  231. prograph-1.3.3.dist-info/METADATA +281 -0
  232. prograph-1.3.3.dist-info/RECORD +237 -0
  233. prograph-1.3.3.dist-info/WHEEL +5 -0
  234. prograph-1.3.3.dist-info/entry_points.txt +3 -0
  235. prograph-1.3.3.dist-info/licenses/LICENSE +201 -0
  236. prograph-1.3.3.dist-info/licenses/NOTICE +10 -0
  237. prograph-1.3.3.dist-info/top_level.txt +1 -0
@@ -0,0 +1,72 @@
1
+ """SQL Server Graph Backend.
2
+
3
+ Executes SQL queries against a SQL Server database. Supports both
4
+ SQLAlchemy engines and raw pyodbc connections.
5
+
6
+ Usage:
7
+
8
+ # SQLAlchemy
9
+ from sqlalchemy import create_engine
10
+ conn = create_engine('mssql+pyodbc://user:pass@host/db?driver=...')
11
+ graph = SQLServerGraph(schema, conn)
12
+
13
+ # pyodbc
14
+ import pyodbc
15
+ conn = pyodbc.connect("DRIVER={ODBC Driver 18 for SQL Server};...")
16
+ graph = SQLServerGraph(schema, conn)
17
+ """
18
+
19
+ from __future__ import annotations
20
+
21
+ from typing import Any, Dict, Optional
22
+
23
+ from .sql_graph import SQLGraph
24
+
25
+
26
+ class SQLServerGraph(SQLGraph):
27
+ """SQL Server-backed graph.
28
+
29
+ Detects whether the connection is a SQLAlchemy engine or a raw
30
+ pyodbc connection and dispatches accordingly.
31
+ """
32
+
33
+ def __init__(
34
+ self,
35
+ schema: Any,
36
+ connection: Any,
37
+ table_stats: Optional[Dict[str, int]] = None,
38
+ ):
39
+ super().__init__(schema, connection, dialect='sqlserver', table_stats=table_stats)
40
+ self._is_sqlalchemy = hasattr(connection, 'connect') and hasattr(connection, 'execute')
41
+
42
+ def _fetch(self, sql: str):
43
+ """Execute SQL against SQL Server."""
44
+ if self._is_sqlalchemy:
45
+ return self._fetch_sqlalchemy(sql)
46
+ return self._fetch_pyodbc(sql)
47
+
48
+ def _fetch_sqlalchemy(self, sql: str):
49
+ """Execute via SQLAlchemy engine."""
50
+ from sqlalchemy import text
51
+ from prograph.execution import StatementGuard
52
+ # No cancel through SQLAlchemy: a cancelled query stops before its next statement.
53
+ with StatementGuard(), self._connection.connect() as conn:
54
+ result = conn.execute(text(sql))
55
+ if not result.returns_rows:
56
+ return [], []
57
+ return list(result.keys()), result.fetchall()
58
+
59
+ def _fetch_pyodbc(self, sql: str):
60
+ """Execute via pyodbc connection; a cancel stops the statement
61
+ (`cursor.cancel()`, ODBC's SQLCancel)."""
62
+ from prograph.execution import StatementGuard, checkpoint
63
+ checkpoint()
64
+ cursor = self._connection.cursor()
65
+ try:
66
+ with StatementGuard(cursor):
67
+ cursor.execute(sql)
68
+ if cursor.description is None:
69
+ return [], []
70
+ return [desc[0] for desc in cursor.description], cursor.fetchall()
71
+ finally:
72
+ cursor.close()
prograph/hints.py ADDED
@@ -0,0 +1,95 @@
1
+ """Query hints: a `/*+ ... */` block before the query text.
2
+
3
+ /*+ terms=all */ SELECT ?s ?o WHERE { ?s ?p ?o }
4
+
5
+ `terms`, SPARQL's: `all` returns every SELECT variable as a term struct
6
+ {value, type, datatype, lang}; `auto` (the default) only the variables that
7
+ may hold several kinds of term. `path_depth`, a whole number from 1 to 1000:
8
+ the longest walk a property path's closure (p*, p+) follows on Spark and
9
+ Databricks, 64 by default; a longer one raises. `refuse`, a costly shape
10
+ (`unpinned-join`, `unseeded-closure`, `whole-graph`) or `all`: the query is
11
+ refused before it runs where it has that shape (`prograph.plan.ir.cost`). `semantics`, `default` or
12
+ `core`: the profile the query is planned under, over the engine's (`prograph.plan.ir.semantics`); an
13
+ unknown name raises QueryError (a ValueError). Any other hint, or a value a hint does not take, is not
14
+ applied and is logged (`query_hint_ignored`).
15
+ """
16
+
17
+ import re
18
+ from dataclasses import dataclass
19
+ from typing import Optional, Tuple
20
+ from prograph.rules import module_home
21
+
22
+ module_home("query-hints", "Query hints",
23
+ terms=("hint", "/*+", "terms=all", "parse_hints"))
24
+
25
+
26
+ @dataclass
27
+ class QueryHints:
28
+ """The hints of a query's block."""
29
+
30
+ # SPARQL result terms: 'all' | 'auto'.
31
+ terms: Optional[str] = None
32
+ # The longest walk a closure follows on Spark and Databricks (None: the default, 64).
33
+ path_depth: Optional[int] = None
34
+ # A costly shape this query is refused for (`prograph.plan.ir.cost`): one shape, or all.
35
+ refuse: Optional[str] = None
36
+ # The semantics profile the query is planned under (`prograph.plan.ir.semantics.PROFILES`).
37
+ semantics: Optional[str] = None
38
+ # A dataset the caller states (SPARQL Protocol 2.1.4): (default graph IRIs, named graph IRIs), used in
39
+ # place of the query's own FROM and FROM NAMED. Set by the caller, never read from the text.
40
+ dataset: Optional[Tuple[Tuple[str, ...], Tuple[str, ...]]] = None
41
+
42
+ def __bool__(self) -> bool:
43
+ return (self.terms is not None or self.path_depth is not None or self.refuse is not None
44
+ or self.semantics is not None or self.dataset is not None)
45
+
46
+
47
+ # The hint block: /*+ ... */, over several lines.
48
+ HINT_BLOCK_PATTERN = re.compile(r'/\*\+\s*(.*?)\s*\*/', re.DOTALL)
49
+
50
+ # A key=value hint, with optional whitespace around =.
51
+ _KEY_VALUE = re.compile(r'(\w+)\s*=\s*([\w-]+)')
52
+
53
+ # The values each hint takes.
54
+ _HINT_VALUES = {'terms': ('all', 'auto'),
55
+ 'refuse': ('all', 'unpinned-join', 'unseeded-closure', 'whole-graph')}
56
+
57
+
58
+ def parse_hints(query: str) -> Tuple[str, QueryHints]:
59
+ """The query's text without its hint block, and the block's hints."""
60
+ hints = QueryHints()
61
+ match = HINT_BLOCK_PATTERN.search(query)
62
+ if not match:
63
+ return query, hints
64
+ cleaned = (query[:match.start()] + query[match.end():]).strip()
65
+ content = match.group(1).replace('\n', ' ')
66
+ for kv in _KEY_VALUE.finditer(content):
67
+ key, value = kv.group(1).lower(), kv.group(2)
68
+ if key == 'path_depth':
69
+ if value.isdigit() and 1 <= int(value) <= 1000:
70
+ hints.path_depth = int(value)
71
+ else:
72
+ _ignored(key, value, ('1 to 1000',))
73
+ continue
74
+ if key == 'semantics':
75
+ from prograph.plan.ir.semantics import named
76
+ try:
77
+ named(value.lower())
78
+ except ValueError as error: # refused by name, as a query that names what it does not declare
79
+ from prograph.plan.ir.sparql_front import QueryError
80
+ raise QueryError(f"the semantics hint: {error}") from None
81
+ hints.semantics = value.lower()
82
+ continue
83
+ valid = _HINT_VALUES.get(key)
84
+ if valid is not None and value.lower() in valid:
85
+ setattr(hints, key, value.lower())
86
+ else:
87
+ _ignored(key, value, valid or ())
88
+ return cleaned, hints
89
+
90
+
91
+ def _ignored(hint: str, value: str, valid_values) -> None:
92
+ """Log a hint that is not applied (`query_hint_ignored`)."""
93
+ from prograph.logging import get_plan_logger
94
+ get_plan_logger().warning(
95
+ "query_hint_ignored", hint=hint, value=value, valid_values=list(valid_values))