foundry-dev-tools 2.1.19__tar.gz → 2.1.20__tar.gz

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 (80) hide show
  1. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/PKG-INFO +1 -1
  2. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/pyproject.toml +1 -1
  3. foundry_dev_tools-2.1.20/src/foundry_dev_tools/__about__.py +1 -0
  4. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/magritte_coordinator.py +109 -0
  5. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/api_types.py +3 -0
  6. foundry_dev_tools-2.1.19/src/foundry_dev_tools/__about__.py +0 -1
  7. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/README.md +0 -0
  8. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/__init__.py +0 -0
  9. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/_optional/__init__.py +0 -0
  10. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/_optional/pandas.py +0 -0
  11. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/_optional/polars.py +0 -0
  12. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/_optional/pyarrow.py +0 -0
  13. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/_optional/pyspark.py +0 -0
  14. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/cached_foundry_client.py +0 -0
  15. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/cli/__init__.py +0 -0
  16. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/cli/build.py +0 -0
  17. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/cli/config.py +0 -0
  18. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/cli/git.py +0 -0
  19. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/cli/git_credential_foundry.py +0 -0
  20. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/cli/info.py +0 -0
  21. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/cli/main.py +0 -0
  22. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/cli/s3.py +0 -0
  23. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/cli/stubs.py +0 -0
  24. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/__init__.py +0 -0
  25. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/api_client.py +0 -0
  26. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/build2.py +0 -0
  27. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/catalog.py +0 -0
  28. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/compass.py +0 -0
  29. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/context_client.py +0 -0
  30. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/data_proxy.py +0 -0
  31. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/foundry_sql_server.py +0 -0
  32. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/foundry_stats.py +0 -0
  33. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/jemma.py +0 -0
  34. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/metadata.py +0 -0
  35. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/multipass.py +0 -0
  36. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/public_ontologies_client.py +0 -0
  37. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/s3_client.py +0 -0
  38. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/scheduler.py +0 -0
  39. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/schema_inference.py +0 -0
  40. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/clients/tables.py +0 -0
  41. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/config/__init__.py +0 -0
  42. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/config/config.py +0 -0
  43. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/config/config_types.py +0 -0
  44. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/config/context.py +0 -0
  45. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/config/token_provider.py +0 -0
  46. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/errors/__init__.py +0 -0
  47. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/errors/compass.py +0 -0
  48. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/errors/config.py +0 -0
  49. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/errors/dataset.py +0 -0
  50. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/errors/handling.py +0 -0
  51. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/errors/meta.py +0 -0
  52. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/errors/multipass.py +0 -0
  53. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/errors/sql.py +0 -0
  54. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/foundry_api_client.py +0 -0
  55. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/helpers/__init__.py +0 -0
  56. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/helpers/multipass/__init__.py +0 -0
  57. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/helpers/multipass/group.py +0 -0
  58. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/helpers/multipass/principal.py +0 -0
  59. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/helpers/multipass/user.py +0 -0
  60. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/py.typed +0 -0
  61. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/resources/__init__.py +0 -0
  62. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/resources/dataset.py +0 -0
  63. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/resources/folder.py +0 -0
  64. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/resources/resource.py +0 -0
  65. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/__init__.py +0 -0
  66. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/async_s3.py +0 -0
  67. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/caches/__init__.py +0 -0
  68. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/caches/metadata_store.py +0 -0
  69. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/caches/spark_caches.py +0 -0
  70. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/cli.py +0 -0
  71. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/clients.py +0 -0
  72. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/compat.py +0 -0
  73. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/config.py +0 -0
  74. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/converter/__init__.py +0 -0
  75. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/converter/foundry_spark.py +0 -0
  76. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/misc.py +0 -0
  77. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/public_api_types.py +0 -0
  78. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/repo.py +0 -0
  79. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/s3.py +0 -0
  80. {foundry_dev_tools-2.1.19 → foundry_dev_tools-2.1.20}/src/foundry_dev_tools/utils/spark.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: foundry-dev-tools
3
- Version: 2.1.19
3
+ Version: 2.1.20
4
4
  Summary: Seamlessly run your Palantir Foundry Repository transforms code on your local machine.
5
5
  Author-Email: Nicolas Renkamp <nicolas.renkamp@merckgroup.com>, Jonas Wunderlich <jonas.wunderlich@merckgroup.com>
6
6
  License: Apache-2.0
@@ -41,7 +41,7 @@ dependencies = [
41
41
  "tomli_w",
42
42
  ]
43
43
  dynamic = []
44
- version = "2.1.19"
44
+ version = "2.1.20"
45
45
 
46
46
  [project.license]
47
47
  text = "Apache-2.0"
@@ -0,0 +1 @@
1
+ __version__ = '2.1.20'
@@ -11,11 +11,14 @@ if TYPE_CHECKING:
11
11
 
12
12
  from foundry_dev_tools.utils.api_types import (
13
13
  CodeResourceType,
14
+ DatasetRid,
15
+ ExtractRid,
14
16
  FolderRid,
15
17
  MarkingId,
16
18
  NetworkEgressPolicyRid,
17
19
  Rid,
18
20
  SourceRid,
21
+ TransactionType,
19
22
  )
20
23
 
21
24
 
@@ -170,6 +173,17 @@ class MagritteCoordinatorClient(APIClient):
170
173
  )
171
174
  return response.json()
172
175
 
176
+ def api_delete_extract(self, extract_rid: ExtractRid, **kwargs) -> requests.Response:
177
+ """Pernamently deletes given magritte extract.
178
+
179
+ If successful, HTTP 204 status code is returned (no content).
180
+
181
+ Args:
182
+ extract_rid: Rid of the desired extract/sync to be deleted.
183
+ **kwargs: gets passed to :py:meth:`APIClient.api_request`
184
+ """
185
+ return self.api_request("DELETE", f"build/delete-extract/{extract_rid}", **kwargs)
186
+
173
187
  def get_source_config(self, source_rid: SourceRid) -> dict:
174
188
  """Returns the configuration of a Source."""
175
189
  return self.api_bulk_get_source_config(source_rids={source_rid}).json()[source_rid]
@@ -201,6 +215,101 @@ class MagritteCoordinatorClient(APIClient):
201
215
  **kwargs,
202
216
  )
203
217
 
218
+ def api_add_extract_for_branch(self, branch_name: str, payload: dict, **kwargs) -> requests.Response:
219
+ """Returns a new source RID."""
220
+ return self.api_request(
221
+ "POST",
222
+ f"build/add-extract?branchName={branch_name}",
223
+ json=payload,
224
+ **kwargs,
225
+ )
226
+
227
+ def create_new_extract_for_source(
228
+ self,
229
+ branch_name: str,
230
+ dataset_rid: DatasetRid,
231
+ source_rid: SourceRid,
232
+ extract_name: str,
233
+ transaction_type: TransactionType,
234
+ source_adapter: dict,
235
+ spark_profiles: list[str] | None = None,
236
+ ) -> str:
237
+ r"""Creates a new Foundry extract from a given source.
238
+
239
+ The `.json()` at the end does return a string value and not a dict-like structure.
240
+
241
+ Usage:
242
+ ```python
243
+ >>> sync_rid = magritte_client.create_new_extract_for_source(
244
+ ... branch_name="master",
245
+ ... dataset_rid="ri.foundry.main.dataset.xxxxxx-xxxx-xxxx-xxxx-xxxxxxx",
246
+ ... source_rid="ri.magritte..source.xxxxxx-xxxx-xxxx-xxxx-xxxxxxx",
247
+ ... extract_name="all_flights",
248
+ ... transaction_type="SNAPSHOT",
249
+ ... source_adapter= {
250
+ ... "type": "jdbc-source-adapter", # for a jdbc-type connector
251
+ ... "jdbcOptions": {
252
+ ... "preQueries": [],
253
+ ... "query": {
254
+ ... "sqlQuery": "SELECT * FROM \"AIRPORT_DB\".\"FLIGHTS\""
255
+ ... },
256
+ ... }
257
+ ... },
258
+ ... spark_profiles=[] # only work with a non-agent type of exports
259
+ ... )
260
+ ```
261
+
262
+ Args:
263
+ branch_name: Name of the branch where the data should land.
264
+ dataset_rid: Dataset RID.
265
+ source_rid: Source RID from which the extract/sync will be spawned from.
266
+ extract_name: Name of the new extract/sync.
267
+ transaction_type: One of the options available within `TransactionType`
268
+ source_adapter: Dictionary specifying the source adapter configuration. Must include:
269
+ - type (str): Adapter type, e.g., "jdbc-source-adapter".
270
+ - jdbcOptions (dict, optional): For JDBC adapters, must include:
271
+ - preQueries (list[str]): List of SQL queries to run before main query.
272
+ - query (dict): Must include:
273
+ - sqlQuery (str): The SQL query to execute.
274
+ - Example:
275
+ {
276
+ "type": "jdbc-source-adapter",
277
+ "jdbcOptions": {
278
+ "preQueries": [],
279
+ "query": {
280
+ "sqlQuery": "SELECT * FROM \"AIRPORT_DB\".\"FLIGHTS\""
281
+ }
282
+ }
283
+ }
284
+ spark_profiles: list[str]. A list of spark profile names to use.
285
+ Not available when using agent-based extracts.
286
+
287
+ Returns:
288
+ str: The extract RID of the newly created extract.
289
+ """
290
+ payload = {
291
+ "datasetId": dataset_rid,
292
+ "branchName": branch_name,
293
+ "extractConfig": {
294
+ "sourceAdapter": source_adapter,
295
+ "outputOptions": {"transactionType": transaction_type},
296
+ },
297
+ "outputOptions": {"transactionType": transaction_type},
298
+ "outputConstraints": [{"consistentOutputSchema": {}, "type": "consistentOutputSchema"}],
299
+ "schemaOptions": {},
300
+ "timestampOptions": {
301
+ "useTimestampType": False,
302
+ "timestampWithoutTzOptions": {"asString": {}, "type": "asString"},
303
+ },
304
+ "transactionType": transaction_type,
305
+ "sourceAdapter": source_adapter,
306
+ "extractName": extract_name,
307
+ "sourceId": source_rid,
308
+ "sparkProfiles": spark_profiles or [],
309
+ }
310
+
311
+ return self.api_add_extract_for_branch(branch_name=branch_name, payload=payload).json()
312
+
204
313
  def api_get_runtime_platform(self, source_rid: SourceRid, **kwargs) -> requests.Response:
205
314
  """Get runtime platform information for a source.
206
315
 
@@ -71,6 +71,9 @@ ProjectRid = str
71
71
  SourceRid = str
72
72
  """A magritte source resource identifier."""
73
73
 
74
+ ExtractRid = str
75
+ """A magritte extract resource identifier."""
76
+
74
77
  TableRid = str
75
78
  """A virtual table resource identifier."""
76
79
 
@@ -1 +0,0 @@
1
- __version__ = '2.1.19'