databricks-sdk 0.56.0__py3-none-any.whl → 0.57.0__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.
Potentially problematic release.
This version of databricks-sdk might be problematic. Click here for more details.
- databricks/sdk/__init__.py +15 -9
- databricks/sdk/service/aibuilder.py +157 -16
- databricks/sdk/service/apps.py +14 -42
- databricks/sdk/service/billing.py +17 -51
- databricks/sdk/service/catalog.py +198 -399
- databricks/sdk/service/cleanrooms.py +11 -33
- databricks/sdk/service/compute.py +63 -189
- databricks/sdk/service/dashboards.py +21 -63
- databricks/sdk/service/database.py +45 -30
- databricks/sdk/service/files.py +18 -54
- databricks/sdk/service/iam.py +55 -165
- databricks/sdk/service/jobs.py +232 -85
- databricks/sdk/service/marketplace.py +46 -146
- databricks/sdk/service/ml.py +455 -216
- databricks/sdk/service/oauth2.py +17 -45
- databricks/sdk/service/pipelines.py +81 -40
- databricks/sdk/service/provisioning.py +30 -90
- databricks/sdk/service/qualitymonitorv2.py +5 -15
- databricks/sdk/service/serving.py +30 -42
- databricks/sdk/service/settings.py +103 -314
- databricks/sdk/service/sharing.py +30 -86
- databricks/sdk/service/sql.py +74 -184
- databricks/sdk/service/vectorsearch.py +13 -43
- databricks/sdk/service/workspace.py +35 -105
- databricks/sdk/version.py +1 -1
- {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/METADATA +1 -1
- {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/RECORD +31 -31
- {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/WHEEL +0 -0
- {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/licenses/LICENSE +0 -0
- {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/licenses/NOTICE +0 -0
- {databricks_sdk-0.56.0.dist-info → databricks_sdk-0.57.0.dist-info}/top_level.txt +0 -0
|
@@ -520,8 +520,10 @@ class AwsIamRole:
|
|
|
520
520
|
|
|
521
521
|
@dataclass
|
|
522
522
|
class AwsIamRoleRequest:
|
|
523
|
+
"""The AWS IAM role configuration"""
|
|
524
|
+
|
|
523
525
|
role_arn: str
|
|
524
|
-
"""The Amazon Resource Name (ARN) of the AWS IAM role
|
|
526
|
+
"""The Amazon Resource Name (ARN) of the AWS IAM role used to vend temporary credentials."""
|
|
525
527
|
|
|
526
528
|
def as_dict(self) -> dict:
|
|
527
529
|
"""Serializes the AwsIamRoleRequest into a dictionary suitable for use as a JSON request body."""
|
|
@@ -545,11 +547,13 @@ class AwsIamRoleRequest:
|
|
|
545
547
|
|
|
546
548
|
@dataclass
|
|
547
549
|
class AwsIamRoleResponse:
|
|
550
|
+
"""The AWS IAM role configuration"""
|
|
551
|
+
|
|
548
552
|
role_arn: str
|
|
549
|
-
"""The Amazon Resource Name (ARN) of the AWS IAM role
|
|
553
|
+
"""The Amazon Resource Name (ARN) of the AWS IAM role used to vend temporary credentials."""
|
|
550
554
|
|
|
551
555
|
external_id: Optional[str] = None
|
|
552
|
-
"""The external ID used in role assumption to prevent confused deputy problem
|
|
556
|
+
"""The external ID used in role assumption to prevent the confused deputy problem."""
|
|
553
557
|
|
|
554
558
|
unity_catalog_iam_arn: Optional[str] = None
|
|
555
559
|
"""The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity
|
|
@@ -659,9 +663,7 @@ class AzureManagedIdentity:
|
|
|
659
663
|
`/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}`."""
|
|
660
664
|
|
|
661
665
|
credential_id: Optional[str] = None
|
|
662
|
-
"""The Databricks internal ID that represents this managed identity.
|
|
663
|
-
persist the credential_id once it is fetched from the credentials manager - as we only use the
|
|
664
|
-
protobuf serializer to store credentials, this ID gets persisted to the database. ."""
|
|
666
|
+
"""The Databricks internal ID that represents this managed identity."""
|
|
665
667
|
|
|
666
668
|
managed_identity_id: Optional[str] = None
|
|
667
669
|
"""The Azure resource ID of the managed identity. Use the format,
|
|
@@ -704,16 +706,18 @@ class AzureManagedIdentity:
|
|
|
704
706
|
|
|
705
707
|
@dataclass
|
|
706
708
|
class AzureManagedIdentityRequest:
|
|
709
|
+
"""The Azure managed identity configuration."""
|
|
710
|
+
|
|
707
711
|
access_connector_id: str
|
|
708
712
|
"""The Azure resource ID of the Azure Databricks Access Connector. Use the format
|
|
709
|
-
|
|
713
|
+
`/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}`."""
|
|
710
714
|
|
|
711
715
|
managed_identity_id: Optional[str] = None
|
|
712
|
-
"""The Azure resource ID of the managed identity. Use the format
|
|
713
|
-
|
|
716
|
+
"""The Azure resource ID of the managed identity. Use the format,
|
|
717
|
+
`/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}`
|
|
714
718
|
This is only available for user-assgined identities. For system-assigned identities, the
|
|
715
719
|
access_connector_id is used to identify the identity. If this field is not provided, then we
|
|
716
|
-
assume the AzureManagedIdentity is
|
|
720
|
+
assume the AzureManagedIdentity is using the system-assigned identity."""
|
|
717
721
|
|
|
718
722
|
def as_dict(self) -> dict:
|
|
719
723
|
"""Serializes the AzureManagedIdentityRequest into a dictionary suitable for use as a JSON request body."""
|
|
@@ -744,19 +748,21 @@ class AzureManagedIdentityRequest:
|
|
|
744
748
|
|
|
745
749
|
@dataclass
|
|
746
750
|
class AzureManagedIdentityResponse:
|
|
751
|
+
"""The Azure managed identity configuration."""
|
|
752
|
+
|
|
747
753
|
access_connector_id: str
|
|
748
754
|
"""The Azure resource ID of the Azure Databricks Access Connector. Use the format
|
|
749
|
-
|
|
755
|
+
`/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}`."""
|
|
750
756
|
|
|
751
757
|
credential_id: Optional[str] = None
|
|
752
758
|
"""The Databricks internal ID that represents this managed identity."""
|
|
753
759
|
|
|
754
760
|
managed_identity_id: Optional[str] = None
|
|
755
|
-
"""The Azure resource ID of the managed identity. Use the format
|
|
756
|
-
|
|
761
|
+
"""The Azure resource ID of the managed identity. Use the format,
|
|
762
|
+
`/subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}`
|
|
757
763
|
This is only available for user-assgined identities. For system-assigned identities, the
|
|
758
764
|
access_connector_id is used to identify the identity. If this field is not provided, then we
|
|
759
|
-
assume the AzureManagedIdentity is
|
|
765
|
+
assume the AzureManagedIdentity is using the system-assigned identity."""
|
|
760
766
|
|
|
761
767
|
def as_dict(self) -> dict:
|
|
762
768
|
"""Serializes the AzureManagedIdentityResponse into a dictionary suitable for use as a JSON request body."""
|
|
@@ -1162,14 +1168,17 @@ class CatalogType(Enum):
|
|
|
1162
1168
|
|
|
1163
1169
|
@dataclass
|
|
1164
1170
|
class CloudflareApiToken:
|
|
1171
|
+
"""The Cloudflare API token configuration. Read more at
|
|
1172
|
+
https://developers.cloudflare.com/r2/api/s3/tokens/"""
|
|
1173
|
+
|
|
1165
1174
|
access_key_id: str
|
|
1166
|
-
"""The
|
|
1175
|
+
"""The access key ID associated with the API token."""
|
|
1167
1176
|
|
|
1168
1177
|
secret_access_key: str
|
|
1169
|
-
"""The secret access token generated for the access key
|
|
1178
|
+
"""The secret access token generated for the above access key ID."""
|
|
1170
1179
|
|
|
1171
1180
|
account_id: str
|
|
1172
|
-
"""The account
|
|
1181
|
+
"""The ID of the account associated with the API token."""
|
|
1173
1182
|
|
|
1174
1183
|
def as_dict(self) -> dict:
|
|
1175
1184
|
"""Serializes the CloudflareApiToken into a dictionary suitable for use as a JSON request body."""
|
|
@@ -1542,7 +1551,7 @@ class ConnectionInfo:
|
|
|
1542
1551
|
|
|
1543
1552
|
|
|
1544
1553
|
class ConnectionType(Enum):
|
|
1545
|
-
"""Next Id:
|
|
1554
|
+
"""Next Id: 33"""
|
|
1546
1555
|
|
|
1547
1556
|
BIGQUERY = "BIGQUERY"
|
|
1548
1557
|
DATABRICKS = "DATABRICKS"
|
|
@@ -1773,19 +1782,19 @@ class CreateCredentialRequest:
|
|
|
1773
1782
|
metastore."""
|
|
1774
1783
|
|
|
1775
1784
|
aws_iam_role: Optional[AwsIamRole] = None
|
|
1776
|
-
"""The AWS IAM role configuration"""
|
|
1785
|
+
"""The AWS IAM role configuration."""
|
|
1777
1786
|
|
|
1778
1787
|
azure_managed_identity: Optional[AzureManagedIdentity] = None
|
|
1779
1788
|
"""The Azure managed identity configuration."""
|
|
1780
1789
|
|
|
1781
1790
|
azure_service_principal: Optional[AzureServicePrincipal] = None
|
|
1782
|
-
"""The Azure service principal configuration.
|
|
1791
|
+
"""The Azure service principal configuration."""
|
|
1783
1792
|
|
|
1784
1793
|
comment: Optional[str] = None
|
|
1785
1794
|
"""Comment associated with the credential."""
|
|
1786
1795
|
|
|
1787
1796
|
databricks_gcp_service_account: Optional[DatabricksGcpServiceAccount] = None
|
|
1788
|
-
"""
|
|
1797
|
+
"""The Databricks managed GCP service account configuration."""
|
|
1789
1798
|
|
|
1790
1799
|
purpose: Optional[CredentialPurpose] = None
|
|
1791
1800
|
"""Indicates the purpose of the credential."""
|
|
@@ -2563,7 +2572,8 @@ class CreateSchema:
|
|
|
2563
2572
|
@dataclass
|
|
2564
2573
|
class CreateStorageCredential:
|
|
2565
2574
|
name: str
|
|
2566
|
-
"""The credential name. The name must be unique within the
|
|
2575
|
+
"""The credential name. The name must be unique among storage and service credentials within the
|
|
2576
|
+
metastore."""
|
|
2567
2577
|
|
|
2568
2578
|
aws_iam_role: Optional[AwsIamRoleRequest] = None
|
|
2569
2579
|
"""The AWS IAM role configuration."""
|
|
@@ -2584,7 +2594,8 @@ class CreateStorageCredential:
|
|
|
2584
2594
|
"""The Databricks managed GCP service account configuration."""
|
|
2585
2595
|
|
|
2586
2596
|
read_only: Optional[bool] = None
|
|
2587
|
-
"""Whether the
|
|
2597
|
+
"""Whether the credential is usable only for read operations. Only applicable when purpose is
|
|
2598
|
+
**STORAGE**."""
|
|
2588
2599
|
|
|
2589
2600
|
skip_validation: Optional[bool] = None
|
|
2590
2601
|
"""Supplying true to this argument skips validation of the created credential."""
|
|
@@ -2760,13 +2771,13 @@ class CreateVolumeRequestContent:
|
|
|
2760
2771
|
@dataclass
|
|
2761
2772
|
class CredentialInfo:
|
|
2762
2773
|
aws_iam_role: Optional[AwsIamRole] = None
|
|
2763
|
-
"""The AWS IAM role configuration"""
|
|
2774
|
+
"""The AWS IAM role configuration."""
|
|
2764
2775
|
|
|
2765
2776
|
azure_managed_identity: Optional[AzureManagedIdentity] = None
|
|
2766
2777
|
"""The Azure managed identity configuration."""
|
|
2767
2778
|
|
|
2768
2779
|
azure_service_principal: Optional[AzureServicePrincipal] = None
|
|
2769
|
-
"""The Azure service principal configuration.
|
|
2780
|
+
"""The Azure service principal configuration."""
|
|
2770
2781
|
|
|
2771
2782
|
comment: Optional[str] = None
|
|
2772
2783
|
"""Comment associated with the credential."""
|
|
@@ -2778,7 +2789,7 @@ class CredentialInfo:
|
|
|
2778
2789
|
"""Username of credential creator."""
|
|
2779
2790
|
|
|
2780
2791
|
databricks_gcp_service_account: Optional[DatabricksGcpServiceAccount] = None
|
|
2781
|
-
"""
|
|
2792
|
+
"""The Databricks managed GCP service account configuration."""
|
|
2782
2793
|
|
|
2783
2794
|
full_name: Optional[str] = None
|
|
2784
2795
|
"""The full name of the credential."""
|
|
@@ -3011,9 +3022,7 @@ class DatabricksGcpServiceAccount:
|
|
|
3011
3022
|
"""GCP long-lived credential. Databricks-created Google Cloud Storage service account."""
|
|
3012
3023
|
|
|
3013
3024
|
credential_id: Optional[str] = None
|
|
3014
|
-
"""The Databricks internal ID that represents this managed identity.
|
|
3015
|
-
persist the credential_id once it is fetched from the credentials manager - as we only use the
|
|
3016
|
-
protobuf serializer to store credentials, this ID gets persisted to the database"""
|
|
3025
|
+
"""The Databricks internal ID that represents this managed identity."""
|
|
3017
3026
|
|
|
3018
3027
|
email: Optional[str] = None
|
|
3019
3028
|
"""The email of the service account."""
|
|
@@ -3055,6 +3064,8 @@ class DatabricksGcpServiceAccount:
|
|
|
3055
3064
|
|
|
3056
3065
|
@dataclass
|
|
3057
3066
|
class DatabricksGcpServiceAccountRequest:
|
|
3067
|
+
"""GCP long-lived credential. Databricks-created Google Cloud Storage service account."""
|
|
3068
|
+
|
|
3058
3069
|
def as_dict(self) -> dict:
|
|
3059
3070
|
"""Serializes the DatabricksGcpServiceAccountRequest into a dictionary suitable for use as a JSON request body."""
|
|
3060
3071
|
body = {}
|
|
@@ -3073,11 +3084,13 @@ class DatabricksGcpServiceAccountRequest:
|
|
|
3073
3084
|
|
|
3074
3085
|
@dataclass
|
|
3075
3086
|
class DatabricksGcpServiceAccountResponse:
|
|
3087
|
+
"""GCP long-lived credential. Databricks-created Google Cloud Storage service account."""
|
|
3088
|
+
|
|
3076
3089
|
credential_id: Optional[str] = None
|
|
3077
|
-
"""The Databricks internal ID that represents this
|
|
3090
|
+
"""The Databricks internal ID that represents this managed identity."""
|
|
3078
3091
|
|
|
3079
3092
|
email: Optional[str] = None
|
|
3080
|
-
"""The email of the service account.
|
|
3093
|
+
"""The email of the service account."""
|
|
3081
3094
|
|
|
3082
3095
|
def as_dict(self) -> dict:
|
|
3083
3096
|
"""Serializes the DatabricksGcpServiceAccountResponse into a dictionary suitable for use as a JSON request body."""
|
|
@@ -7834,7 +7847,7 @@ class StorageCredentialInfo:
|
|
|
7834
7847
|
"""Comment associated with the credential."""
|
|
7835
7848
|
|
|
7836
7849
|
created_at: Optional[int] = None
|
|
7837
|
-
"""Time at which this
|
|
7850
|
+
"""Time at which this credential was created, in epoch milliseconds."""
|
|
7838
7851
|
|
|
7839
7852
|
created_by: Optional[str] = None
|
|
7840
7853
|
"""Username of credential creator."""
|
|
@@ -7849,18 +7862,21 @@ class StorageCredentialInfo:
|
|
|
7849
7862
|
"""The unique identifier of the credential."""
|
|
7850
7863
|
|
|
7851
7864
|
isolation_mode: Optional[IsolationMode] = None
|
|
7865
|
+
"""Whether the current securable is accessible from all workspaces or a specific set of workspaces."""
|
|
7852
7866
|
|
|
7853
7867
|
metastore_id: Optional[str] = None
|
|
7854
|
-
"""Unique identifier of parent metastore."""
|
|
7868
|
+
"""Unique identifier of the parent metastore."""
|
|
7855
7869
|
|
|
7856
7870
|
name: Optional[str] = None
|
|
7857
|
-
"""The credential name. The name must be unique within the
|
|
7871
|
+
"""The credential name. The name must be unique among storage and service credentials within the
|
|
7872
|
+
metastore."""
|
|
7858
7873
|
|
|
7859
7874
|
owner: Optional[str] = None
|
|
7860
7875
|
"""Username of current owner of credential."""
|
|
7861
7876
|
|
|
7862
7877
|
read_only: Optional[bool] = None
|
|
7863
|
-
"""Whether the
|
|
7878
|
+
"""Whether the credential is usable only for read operations. Only applicable when purpose is
|
|
7879
|
+
**STORAGE**."""
|
|
7864
7880
|
|
|
7865
7881
|
updated_at: Optional[int] = None
|
|
7866
7882
|
"""Time at which this credential was last modified, in epoch milliseconds."""
|
|
@@ -7869,7 +7885,8 @@ class StorageCredentialInfo:
|
|
|
7869
7885
|
"""Username of user who last modified the credential."""
|
|
7870
7886
|
|
|
7871
7887
|
used_for_managed_storage: Optional[bool] = None
|
|
7872
|
-
"""Whether this credential is the current metastore's root storage credential.
|
|
7888
|
+
"""Whether this credential is the current metastore's root storage credential. Only applicable when
|
|
7889
|
+
purpose is **STORAGE**."""
|
|
7873
7890
|
|
|
7874
7891
|
def as_dict(self) -> dict:
|
|
7875
7892
|
"""Serializes the StorageCredentialInfo into a dictionary suitable for use as a JSON request body."""
|
|
@@ -8808,19 +8825,19 @@ class UpdateConnection:
|
|
|
8808
8825
|
@dataclass
|
|
8809
8826
|
class UpdateCredentialRequest:
|
|
8810
8827
|
aws_iam_role: Optional[AwsIamRole] = None
|
|
8811
|
-
"""The AWS IAM role configuration"""
|
|
8828
|
+
"""The AWS IAM role configuration."""
|
|
8812
8829
|
|
|
8813
8830
|
azure_managed_identity: Optional[AzureManagedIdentity] = None
|
|
8814
8831
|
"""The Azure managed identity configuration."""
|
|
8815
8832
|
|
|
8816
8833
|
azure_service_principal: Optional[AzureServicePrincipal] = None
|
|
8817
|
-
"""The Azure service principal configuration.
|
|
8834
|
+
"""The Azure service principal configuration."""
|
|
8818
8835
|
|
|
8819
8836
|
comment: Optional[str] = None
|
|
8820
8837
|
"""Comment associated with the credential."""
|
|
8821
8838
|
|
|
8822
8839
|
databricks_gcp_service_account: Optional[DatabricksGcpServiceAccount] = None
|
|
8823
|
-
"""
|
|
8840
|
+
"""The Databricks managed GCP service account configuration."""
|
|
8824
8841
|
|
|
8825
8842
|
force: Optional[bool] = None
|
|
8826
8843
|
"""Force an update even if there are dependent services (when purpose is **SERVICE**) or dependent
|
|
@@ -9609,6 +9626,7 @@ class UpdateStorageCredential:
|
|
|
9609
9626
|
"""Force update even if there are dependent external locations or external tables."""
|
|
9610
9627
|
|
|
9611
9628
|
isolation_mode: Optional[IsolationMode] = None
|
|
9629
|
+
"""Whether the current securable is accessible from all workspaces or a specific set of workspaces."""
|
|
9612
9630
|
|
|
9613
9631
|
name: Optional[str] = None
|
|
9614
9632
|
"""Name of the storage credential."""
|
|
@@ -9620,7 +9638,8 @@ class UpdateStorageCredential:
|
|
|
9620
9638
|
"""Username of current owner of credential."""
|
|
9621
9639
|
|
|
9622
9640
|
read_only: Optional[bool] = None
|
|
9623
|
-
"""Whether the
|
|
9641
|
+
"""Whether the credential is usable only for read operations. Only applicable when purpose is
|
|
9642
|
+
**STORAGE**."""
|
|
9624
9643
|
|
|
9625
9644
|
skip_validation: Optional[bool] = None
|
|
9626
9645
|
"""Supplying true to this argument skips validation of the updated credential."""
|
|
@@ -10067,7 +10086,7 @@ class ValidateStorageCredential:
|
|
|
10067
10086
|
"""Whether the storage credential is only usable for read operations."""
|
|
10068
10087
|
|
|
10069
10088
|
storage_credential_name: Optional[str] = None
|
|
10070
|
-
"""The name of
|
|
10089
|
+
"""Required. The name of an existing credential or long-lived cloud credential to validate."""
|
|
10071
10090
|
|
|
10072
10091
|
url: Optional[str] = None
|
|
10073
10092
|
"""The external location url to validate."""
|
|
@@ -10212,7 +10231,8 @@ class ValidationResult:
|
|
|
10212
10231
|
|
|
10213
10232
|
|
|
10214
10233
|
class ValidationResultOperation(Enum):
|
|
10215
|
-
"""
|
|
10234
|
+
"""A enum represents the file operation performed on the external location with the storage
|
|
10235
|
+
credential"""
|
|
10216
10236
|
|
|
10217
10237
|
DELETE = "DELETE"
|
|
10218
10238
|
LIST = "LIST"
|
|
@@ -10222,7 +10242,7 @@ class ValidationResultOperation(Enum):
|
|
|
10222
10242
|
|
|
10223
10243
|
|
|
10224
10244
|
class ValidationResultResult(Enum):
|
|
10225
|
-
"""
|
|
10245
|
+
"""A enum represents the result of the file operation"""
|
|
10226
10246
|
|
|
10227
10247
|
FAIL = "FAIL"
|
|
10228
10248
|
PASS = "PASS"
|
|
@@ -10449,9 +10469,7 @@ class AccountMetastoreAssignmentsAPI:
|
|
|
10449
10469
|
def create(
|
|
10450
10470
|
self, workspace_id: int, metastore_id: str, *, metastore_assignment: Optional[CreateMetastoreAssignment] = None
|
|
10451
10471
|
):
|
|
10452
|
-
"""
|
|
10453
|
-
|
|
10454
|
-
Creates an assignment to a metastore for a workspace
|
|
10472
|
+
"""Creates an assignment to a metastore for a workspace
|
|
10455
10473
|
|
|
10456
10474
|
:param workspace_id: int
|
|
10457
10475
|
Workspace ID.
|
|
@@ -10477,9 +10495,7 @@ class AccountMetastoreAssignmentsAPI:
|
|
|
10477
10495
|
)
|
|
10478
10496
|
|
|
10479
10497
|
def delete(self, workspace_id: int, metastore_id: str):
|
|
10480
|
-
"""
|
|
10481
|
-
|
|
10482
|
-
Deletes a metastore assignment to a workspace, leaving the workspace with no metastore.
|
|
10498
|
+
"""Deletes a metastore assignment to a workspace, leaving the workspace with no metastore.
|
|
10483
10499
|
|
|
10484
10500
|
:param workspace_id: int
|
|
10485
10501
|
Workspace ID.
|
|
@@ -10500,9 +10516,7 @@ class AccountMetastoreAssignmentsAPI:
|
|
|
10500
10516
|
)
|
|
10501
10517
|
|
|
10502
10518
|
def get(self, workspace_id: int) -> AccountsMetastoreAssignment:
|
|
10503
|
-
"""Gets the metastore assignment for
|
|
10504
|
-
|
|
10505
|
-
Gets the metastore assignment, if any, for the workspace specified by ID. If the workspace is assigned
|
|
10519
|
+
"""Gets the metastore assignment, if any, for the workspace specified by ID. If the workspace is assigned
|
|
10506
10520
|
a metastore, the mappig will be returned. If no metastore is assigned to the workspace, the assignment
|
|
10507
10521
|
will not be found and a 404 returned.
|
|
10508
10522
|
|
|
@@ -10522,9 +10536,7 @@ class AccountMetastoreAssignmentsAPI:
|
|
|
10522
10536
|
return AccountsMetastoreAssignment.from_dict(res)
|
|
10523
10537
|
|
|
10524
10538
|
def list(self, metastore_id: str) -> Iterator[int]:
|
|
10525
|
-
"""
|
|
10526
|
-
|
|
10527
|
-
Gets a list of all Databricks workspace IDs that have been assigned to given metastore.
|
|
10539
|
+
"""Gets a list of all Databricks workspace IDs that have been assigned to given metastore.
|
|
10528
10540
|
|
|
10529
10541
|
:param metastore_id: str
|
|
10530
10542
|
Unity Catalog metastore ID
|
|
@@ -10545,9 +10557,7 @@ class AccountMetastoreAssignmentsAPI:
|
|
|
10545
10557
|
def update(
|
|
10546
10558
|
self, workspace_id: int, metastore_id: str, *, metastore_assignment: Optional[UpdateMetastoreAssignment] = None
|
|
10547
10559
|
):
|
|
10548
|
-
"""Updates
|
|
10549
|
-
|
|
10550
|
-
Updates an assignment to a metastore for a workspace. Currently, only the default catalog may be
|
|
10560
|
+
"""Updates an assignment to a metastore for a workspace. Currently, only the default catalog may be
|
|
10551
10561
|
updated.
|
|
10552
10562
|
|
|
10553
10563
|
:param workspace_id: int
|
|
@@ -10582,9 +10592,7 @@ class AccountMetastoresAPI:
|
|
|
10582
10592
|
self._api = api_client
|
|
10583
10593
|
|
|
10584
10594
|
def create(self, *, metastore_info: Optional[CreateMetastore] = None) -> AccountsMetastoreInfo:
|
|
10585
|
-
"""
|
|
10586
|
-
|
|
10587
|
-
Creates a Unity Catalog metastore.
|
|
10595
|
+
"""Creates a Unity Catalog metastore.
|
|
10588
10596
|
|
|
10589
10597
|
:param metastore_info: :class:`CreateMetastore` (optional)
|
|
10590
10598
|
|
|
@@ -10602,9 +10610,7 @@ class AccountMetastoresAPI:
|
|
|
10602
10610
|
return AccountsMetastoreInfo.from_dict(res)
|
|
10603
10611
|
|
|
10604
10612
|
def delete(self, metastore_id: str, *, force: Optional[bool] = None):
|
|
10605
|
-
"""
|
|
10606
|
-
|
|
10607
|
-
Deletes a Unity Catalog metastore for an account, both specified by ID.
|
|
10613
|
+
"""Deletes a Unity Catalog metastore for an account, both specified by ID.
|
|
10608
10614
|
|
|
10609
10615
|
:param metastore_id: str
|
|
10610
10616
|
Unity Catalog metastore ID
|
|
@@ -10629,9 +10635,7 @@ class AccountMetastoresAPI:
|
|
|
10629
10635
|
)
|
|
10630
10636
|
|
|
10631
10637
|
def get(self, metastore_id: str) -> AccountsMetastoreInfo:
|
|
10632
|
-
"""
|
|
10633
|
-
|
|
10634
|
-
Gets a Unity Catalog metastore from an account, both specified by ID.
|
|
10638
|
+
"""Gets a Unity Catalog metastore from an account, both specified by ID.
|
|
10635
10639
|
|
|
10636
10640
|
:param metastore_id: str
|
|
10637
10641
|
Unity Catalog metastore ID
|
|
@@ -10649,9 +10653,7 @@ class AccountMetastoresAPI:
|
|
|
10649
10653
|
return AccountsMetastoreInfo.from_dict(res)
|
|
10650
10654
|
|
|
10651
10655
|
def list(self) -> Iterator[MetastoreInfo]:
|
|
10652
|
-
"""
|
|
10653
|
-
|
|
10654
|
-
Gets all Unity Catalog metastores associated with an account specified by ID.
|
|
10656
|
+
"""Gets all Unity Catalog metastores associated with an account specified by ID.
|
|
10655
10657
|
|
|
10656
10658
|
:returns: Iterator over :class:`MetastoreInfo`
|
|
10657
10659
|
"""
|
|
@@ -10665,9 +10667,7 @@ class AccountMetastoresAPI:
|
|
|
10665
10667
|
return parsed if parsed is not None else []
|
|
10666
10668
|
|
|
10667
10669
|
def update(self, metastore_id: str, *, metastore_info: Optional[UpdateMetastore] = None) -> AccountsMetastoreInfo:
|
|
10668
|
-
"""
|
|
10669
|
-
|
|
10670
|
-
Updates an existing Unity Catalog metastore.
|
|
10670
|
+
"""Updates an existing Unity Catalog metastore.
|
|
10671
10671
|
|
|
10672
10672
|
:param metastore_id: str
|
|
10673
10673
|
Unity Catalog metastore ID
|
|
@@ -10698,9 +10698,7 @@ class AccountStorageCredentialsAPI:
|
|
|
10698
10698
|
def create(
|
|
10699
10699
|
self, metastore_id: str, *, credential_info: Optional[CreateStorageCredential] = None
|
|
10700
10700
|
) -> AccountsStorageCredentialInfo:
|
|
10701
|
-
"""
|
|
10702
|
-
|
|
10703
|
-
Creates a new storage credential. The request object is specific to the cloud:
|
|
10701
|
+
"""Creates a new storage credential. The request object is specific to the cloud:
|
|
10704
10702
|
|
|
10705
10703
|
* **AwsIamRole** for AWS credentials * **AzureServicePrincipal** for Azure credentials *
|
|
10706
10704
|
**GcpServiceAcountKey** for GCP credentials.
|
|
@@ -10731,9 +10729,7 @@ class AccountStorageCredentialsAPI:
|
|
|
10731
10729
|
return AccountsStorageCredentialInfo.from_dict(res)
|
|
10732
10730
|
|
|
10733
10731
|
def delete(self, metastore_id: str, storage_credential_name: str, *, force: Optional[bool] = None):
|
|
10734
|
-
"""
|
|
10735
|
-
|
|
10736
|
-
Deletes a storage credential from the metastore. The caller must be an owner of the storage
|
|
10732
|
+
"""Deletes a storage credential from the metastore. The caller must be an owner of the storage
|
|
10737
10733
|
credential.
|
|
10738
10734
|
|
|
10739
10735
|
:param metastore_id: str
|
|
@@ -10761,9 +10757,7 @@ class AccountStorageCredentialsAPI:
|
|
|
10761
10757
|
)
|
|
10762
10758
|
|
|
10763
10759
|
def get(self, metastore_id: str, storage_credential_name: str) -> AccountsStorageCredentialInfo:
|
|
10764
|
-
"""Gets
|
|
10765
|
-
|
|
10766
|
-
Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the
|
|
10760
|
+
"""Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the
|
|
10767
10761
|
storage credential, or have a level of privilege on the storage credential.
|
|
10768
10762
|
|
|
10769
10763
|
:param metastore_id: str
|
|
@@ -10786,9 +10780,7 @@ class AccountStorageCredentialsAPI:
|
|
|
10786
10780
|
return AccountsStorageCredentialInfo.from_dict(res)
|
|
10787
10781
|
|
|
10788
10782
|
def list(self, metastore_id: str) -> Iterator[StorageCredentialInfo]:
|
|
10789
|
-
"""
|
|
10790
|
-
|
|
10791
|
-
Gets a list of all storage credentials that have been assigned to given metastore.
|
|
10783
|
+
"""Gets a list of all storage credentials that have been assigned to given metastore.
|
|
10792
10784
|
|
|
10793
10785
|
:param metastore_id: str
|
|
10794
10786
|
Unity Catalog metastore ID
|
|
@@ -10815,9 +10807,7 @@ class AccountStorageCredentialsAPI:
|
|
|
10815
10807
|
*,
|
|
10816
10808
|
credential_info: Optional[UpdateStorageCredential] = None,
|
|
10817
10809
|
) -> AccountsStorageCredentialInfo:
|
|
10818
|
-
"""Updates a storage credential.
|
|
10819
|
-
|
|
10820
|
-
Updates a storage credential on the metastore. The caller must be the owner of the storage credential.
|
|
10810
|
+
"""Updates a storage credential on the metastore. The caller must be the owner of the storage credential.
|
|
10821
10811
|
If the caller is a metastore admin, only the __owner__ credential can be changed.
|
|
10822
10812
|
|
|
10823
10813
|
:param metastore_id: str
|
|
@@ -10853,9 +10843,7 @@ class ArtifactAllowlistsAPI:
|
|
|
10853
10843
|
self._api = api_client
|
|
10854
10844
|
|
|
10855
10845
|
def get(self, artifact_type: ArtifactType) -> ArtifactAllowlistInfo:
|
|
10856
|
-
"""Get
|
|
10857
|
-
|
|
10858
|
-
Get the artifact allowlist of a certain artifact type. The caller must be a metastore admin or have
|
|
10846
|
+
"""Get the artifact allowlist of a certain artifact type. The caller must be a metastore admin or have
|
|
10859
10847
|
the **MANAGE ALLOWLIST** privilege on the metastore.
|
|
10860
10848
|
|
|
10861
10849
|
:param artifact_type: :class:`ArtifactType`
|
|
@@ -10880,9 +10868,7 @@ class ArtifactAllowlistsAPI:
|
|
|
10880
10868
|
created_by: Optional[str] = None,
|
|
10881
10869
|
metastore_id: Optional[str] = None,
|
|
10882
10870
|
) -> ArtifactAllowlistInfo:
|
|
10883
|
-
"""Set
|
|
10884
|
-
|
|
10885
|
-
Set the artifact allowlist of a certain artifact type. The whole artifact allowlist is replaced with
|
|
10871
|
+
"""Set the artifact allowlist of a certain artifact type. The whole artifact allowlist is replaced with
|
|
10886
10872
|
the new allowlist. The caller must be a metastore admin or have the **MANAGE ALLOWLIST** privilege on
|
|
10887
10873
|
the metastore.
|
|
10888
10874
|
|
|
@@ -10942,9 +10928,7 @@ class CatalogsAPI:
|
|
|
10942
10928
|
share_name: Optional[str] = None,
|
|
10943
10929
|
storage_root: Optional[str] = None,
|
|
10944
10930
|
) -> CatalogInfo:
|
|
10945
|
-
"""
|
|
10946
|
-
|
|
10947
|
-
Creates a new catalog instance in the parent metastore if the caller is a metastore admin or has the
|
|
10931
|
+
"""Creates a new catalog instance in the parent metastore if the caller is a metastore admin or has the
|
|
10948
10932
|
**CREATE_CATALOG** privilege.
|
|
10949
10933
|
|
|
10950
10934
|
:param name: str
|
|
@@ -10994,9 +10978,7 @@ class CatalogsAPI:
|
|
|
10994
10978
|
return CatalogInfo.from_dict(res)
|
|
10995
10979
|
|
|
10996
10980
|
def delete(self, name: str, *, force: Optional[bool] = None):
|
|
10997
|
-
"""
|
|
10998
|
-
|
|
10999
|
-
Deletes the catalog that matches the supplied name. The caller must be a metastore admin or the owner
|
|
10981
|
+
"""Deletes the catalog that matches the supplied name. The caller must be a metastore admin or the owner
|
|
11000
10982
|
of the catalog.
|
|
11001
10983
|
|
|
11002
10984
|
:param name: str
|
|
@@ -11017,9 +10999,7 @@ class CatalogsAPI:
|
|
|
11017
10999
|
self._api.do("DELETE", f"/api/2.1/unity-catalog/catalogs/{name}", query=query, headers=headers)
|
|
11018
11000
|
|
|
11019
11001
|
def get(self, name: str, *, include_browse: Optional[bool] = None) -> CatalogInfo:
|
|
11020
|
-
"""
|
|
11021
|
-
|
|
11022
|
-
Gets the specified catalog in a metastore. The caller must be a metastore admin, the owner of the
|
|
11002
|
+
"""Gets the specified catalog in a metastore. The caller must be a metastore admin, the owner of the
|
|
11023
11003
|
catalog, or a user that has the **USE_CATALOG** privilege set for their account.
|
|
11024
11004
|
|
|
11025
11005
|
:param name: str
|
|
@@ -11048,9 +11028,7 @@ class CatalogsAPI:
|
|
|
11048
11028
|
max_results: Optional[int] = None,
|
|
11049
11029
|
page_token: Optional[str] = None,
|
|
11050
11030
|
) -> Iterator[CatalogInfo]:
|
|
11051
|
-
"""
|
|
11052
|
-
|
|
11053
|
-
Gets an array of catalogs in the metastore. If the caller is the metastore admin, all catalogs will be
|
|
11031
|
+
"""Gets an array of catalogs in the metastore. If the caller is the metastore admin, all catalogs will be
|
|
11054
11032
|
retrieved. Otherwise, only catalogs owned by the caller (or for which the caller has the
|
|
11055
11033
|
**USE_CATALOG** privilege) will be retrieved. There is no guarantee of a specific ordering of the
|
|
11056
11034
|
elements in the array.
|
|
@@ -11104,9 +11082,7 @@ class CatalogsAPI:
|
|
|
11104
11082
|
owner: Optional[str] = None,
|
|
11105
11083
|
properties: Optional[Dict[str, str]] = None,
|
|
11106
11084
|
) -> CatalogInfo:
|
|
11107
|
-
"""
|
|
11108
|
-
|
|
11109
|
-
Updates the catalog that matches the supplied name. The caller must be either the owner of the
|
|
11085
|
+
"""Updates the catalog that matches the supplied name. The caller must be either the owner of the
|
|
11110
11086
|
catalog, or a metastore admin (when changing the owner field of the catalog).
|
|
11111
11087
|
|
|
11112
11088
|
:param name: str
|
|
@@ -11175,9 +11151,7 @@ class ConnectionsAPI:
|
|
|
11175
11151
|
properties: Optional[Dict[str, str]] = None,
|
|
11176
11152
|
read_only: Optional[bool] = None,
|
|
11177
11153
|
) -> ConnectionInfo:
|
|
11178
|
-
"""
|
|
11179
|
-
|
|
11180
|
-
Creates a new connection
|
|
11154
|
+
"""Creates a new connection
|
|
11181
11155
|
|
|
11182
11156
|
Creates a new connection to an external data source. It allows users to specify connection details and
|
|
11183
11157
|
configurations for interaction with the external server.
|
|
@@ -11219,9 +11193,7 @@ class ConnectionsAPI:
|
|
|
11219
11193
|
return ConnectionInfo.from_dict(res)
|
|
11220
11194
|
|
|
11221
11195
|
def delete(self, name: str):
|
|
11222
|
-
"""
|
|
11223
|
-
|
|
11224
|
-
Deletes the connection that matches the supplied name.
|
|
11196
|
+
"""Deletes the connection that matches the supplied name.
|
|
11225
11197
|
|
|
11226
11198
|
:param name: str
|
|
11227
11199
|
The name of the connection to be deleted.
|
|
@@ -11236,9 +11208,7 @@ class ConnectionsAPI:
|
|
|
11236
11208
|
self._api.do("DELETE", f"/api/2.1/unity-catalog/connections/{name}", headers=headers)
|
|
11237
11209
|
|
|
11238
11210
|
def get(self, name: str) -> ConnectionInfo:
|
|
11239
|
-
"""
|
|
11240
|
-
|
|
11241
|
-
Gets a connection from it's name.
|
|
11211
|
+
"""Gets a connection from it's name.
|
|
11242
11212
|
|
|
11243
11213
|
:param name: str
|
|
11244
11214
|
Name of the connection.
|
|
@@ -11254,9 +11224,7 @@ class ConnectionsAPI:
|
|
|
11254
11224
|
return ConnectionInfo.from_dict(res)
|
|
11255
11225
|
|
|
11256
11226
|
def list(self, *, max_results: Optional[int] = None, page_token: Optional[str] = None) -> Iterator[ConnectionInfo]:
|
|
11257
|
-
"""List connections.
|
|
11258
|
-
|
|
11259
|
-
List all connections.
|
|
11227
|
+
"""List all connections.
|
|
11260
11228
|
|
|
11261
11229
|
:param max_results: int (optional)
|
|
11262
11230
|
Maximum number of connections to return. - If not set, all connections are returned (not
|
|
@@ -11290,9 +11258,7 @@ class ConnectionsAPI:
|
|
|
11290
11258
|
def update(
|
|
11291
11259
|
self, name: str, options: Dict[str, str], *, new_name: Optional[str] = None, owner: Optional[str] = None
|
|
11292
11260
|
) -> ConnectionInfo:
|
|
11293
|
-
"""
|
|
11294
|
-
|
|
11295
|
-
Updates the connection that matches the supplied name.
|
|
11261
|
+
"""Updates the connection that matches the supplied name.
|
|
11296
11262
|
|
|
11297
11263
|
:param name: str
|
|
11298
11264
|
Name of the connection.
|
|
@@ -11346,9 +11312,7 @@ class CredentialsAPI:
|
|
|
11346
11312
|
read_only: Optional[bool] = None,
|
|
11347
11313
|
skip_validation: Optional[bool] = None,
|
|
11348
11314
|
) -> CredentialInfo:
|
|
11349
|
-
"""
|
|
11350
|
-
|
|
11351
|
-
Creates a new credential. The type of credential to be created is determined by the **purpose** field,
|
|
11315
|
+
"""Creates a new credential. The type of credential to be created is determined by the **purpose** field,
|
|
11352
11316
|
which should be either **SERVICE** or **STORAGE**.
|
|
11353
11317
|
|
|
11354
11318
|
The caller must be a metastore admin or have the metastore privilege **CREATE_STORAGE_CREDENTIAL** for
|
|
@@ -11358,15 +11322,15 @@ class CredentialsAPI:
|
|
|
11358
11322
|
The credential name. The name must be unique among storage and service credentials within the
|
|
11359
11323
|
metastore.
|
|
11360
11324
|
:param aws_iam_role: :class:`AwsIamRole` (optional)
|
|
11361
|
-
The AWS IAM role configuration
|
|
11325
|
+
The AWS IAM role configuration.
|
|
11362
11326
|
:param azure_managed_identity: :class:`AzureManagedIdentity` (optional)
|
|
11363
11327
|
The Azure managed identity configuration.
|
|
11364
11328
|
:param azure_service_principal: :class:`AzureServicePrincipal` (optional)
|
|
11365
|
-
The Azure service principal configuration.
|
|
11329
|
+
The Azure service principal configuration.
|
|
11366
11330
|
:param comment: str (optional)
|
|
11367
11331
|
Comment associated with the credential.
|
|
11368
11332
|
:param databricks_gcp_service_account: :class:`DatabricksGcpServiceAccount` (optional)
|
|
11369
|
-
|
|
11333
|
+
The Databricks managed GCP service account configuration.
|
|
11370
11334
|
:param purpose: :class:`CredentialPurpose` (optional)
|
|
11371
11335
|
Indicates the purpose of the credential.
|
|
11372
11336
|
:param read_only: bool (optional)
|
|
@@ -11405,9 +11369,7 @@ class CredentialsAPI:
|
|
|
11405
11369
|
return CredentialInfo.from_dict(res)
|
|
11406
11370
|
|
|
11407
11371
|
def delete_credential(self, name_arg: str, *, force: Optional[bool] = None):
|
|
11408
|
-
"""
|
|
11409
|
-
|
|
11410
|
-
Deletes a service or storage credential from the metastore. The caller must be an owner of the
|
|
11372
|
+
"""Deletes a service or storage credential from the metastore. The caller must be an owner of the
|
|
11411
11373
|
credential.
|
|
11412
11374
|
|
|
11413
11375
|
:param name_arg: str
|
|
@@ -11435,9 +11397,7 @@ class CredentialsAPI:
|
|
|
11435
11397
|
azure_options: Optional[GenerateTemporaryServiceCredentialAzureOptions] = None,
|
|
11436
11398
|
gcp_options: Optional[GenerateTemporaryServiceCredentialGcpOptions] = None,
|
|
11437
11399
|
) -> TemporaryCredentials:
|
|
11438
|
-
"""
|
|
11439
|
-
|
|
11440
|
-
Returns a set of temporary credentials generated using the specified service credential. The caller
|
|
11400
|
+
"""Returns a set of temporary credentials generated using the specified service credential. The caller
|
|
11441
11401
|
must be a metastore admin or have the metastore privilege **ACCESS** on the service credential.
|
|
11442
11402
|
|
|
11443
11403
|
:param credential_name: str
|
|
@@ -11465,9 +11425,7 @@ class CredentialsAPI:
|
|
|
11465
11425
|
return TemporaryCredentials.from_dict(res)
|
|
11466
11426
|
|
|
11467
11427
|
def get_credential(self, name_arg: str) -> CredentialInfo:
|
|
11468
|
-
"""
|
|
11469
|
-
|
|
11470
|
-
Gets a service or storage credential from the metastore. The caller must be a metastore admin, the
|
|
11428
|
+
"""Gets a service or storage credential from the metastore. The caller must be a metastore admin, the
|
|
11471
11429
|
owner of the credential, or have any permission on the credential.
|
|
11472
11430
|
|
|
11473
11431
|
:param name_arg: str
|
|
@@ -11490,9 +11448,7 @@ class CredentialsAPI:
|
|
|
11490
11448
|
page_token: Optional[str] = None,
|
|
11491
11449
|
purpose: Optional[CredentialPurpose] = None,
|
|
11492
11450
|
) -> Iterator[CredentialInfo]:
|
|
11493
|
-
"""
|
|
11494
|
-
|
|
11495
|
-
Gets an array of credentials (as __CredentialInfo__ objects).
|
|
11451
|
+
"""Gets an array of credentials (as __CredentialInfo__ objects).
|
|
11496
11452
|
|
|
11497
11453
|
The array is limited to only the credentials that the caller has permission to access. If the caller
|
|
11498
11454
|
is a metastore admin, retrieval of credentials is unrestricted. There is no guarantee of a specific
|
|
@@ -11547,9 +11503,7 @@ class CredentialsAPI:
|
|
|
11547
11503
|
read_only: Optional[bool] = None,
|
|
11548
11504
|
skip_validation: Optional[bool] = None,
|
|
11549
11505
|
) -> CredentialInfo:
|
|
11550
|
-
"""
|
|
11551
|
-
|
|
11552
|
-
Updates a service or storage credential on the metastore.
|
|
11506
|
+
"""Updates a service or storage credential on the metastore.
|
|
11553
11507
|
|
|
11554
11508
|
The caller must be the owner of the credential or a metastore admin or have the `MANAGE` permission.
|
|
11555
11509
|
If the caller is a metastore admin, only the __owner__ field can be changed.
|
|
@@ -11557,15 +11511,15 @@ class CredentialsAPI:
|
|
|
11557
11511
|
:param name_arg: str
|
|
11558
11512
|
Name of the credential.
|
|
11559
11513
|
:param aws_iam_role: :class:`AwsIamRole` (optional)
|
|
11560
|
-
The AWS IAM role configuration
|
|
11514
|
+
The AWS IAM role configuration.
|
|
11561
11515
|
:param azure_managed_identity: :class:`AzureManagedIdentity` (optional)
|
|
11562
11516
|
The Azure managed identity configuration.
|
|
11563
11517
|
:param azure_service_principal: :class:`AzureServicePrincipal` (optional)
|
|
11564
|
-
The Azure service principal configuration.
|
|
11518
|
+
The Azure service principal configuration.
|
|
11565
11519
|
:param comment: str (optional)
|
|
11566
11520
|
Comment associated with the credential.
|
|
11567
11521
|
:param databricks_gcp_service_account: :class:`DatabricksGcpServiceAccount` (optional)
|
|
11568
|
-
|
|
11522
|
+
The Databricks managed GCP service account configuration.
|
|
11569
11523
|
:param force: bool (optional)
|
|
11570
11524
|
Force an update even if there are dependent services (when purpose is **SERVICE**) or dependent
|
|
11571
11525
|
external locations and external tables (when purpose is **STORAGE**).
|
|
@@ -11626,9 +11580,7 @@ class CredentialsAPI:
|
|
|
11626
11580
|
read_only: Optional[bool] = None,
|
|
11627
11581
|
url: Optional[str] = None,
|
|
11628
11582
|
) -> ValidateCredentialResponse:
|
|
11629
|
-
"""
|
|
11630
|
-
|
|
11631
|
-
Validates a credential.
|
|
11583
|
+
"""Validates a credential.
|
|
11632
11584
|
|
|
11633
11585
|
For service credentials (purpose is **SERVICE**), either the __credential_name__ or the cloud-specific
|
|
11634
11586
|
credential must be provided.
|
|
@@ -11718,9 +11670,7 @@ class ExternalLocationsAPI:
|
|
|
11718
11670
|
read_only: Optional[bool] = None,
|
|
11719
11671
|
skip_validation: Optional[bool] = None,
|
|
11720
11672
|
) -> ExternalLocationInfo:
|
|
11721
|
-
"""
|
|
11722
|
-
|
|
11723
|
-
Creates a new external location entry in the metastore. The caller must be a metastore admin or have
|
|
11673
|
+
"""Creates a new external location entry in the metastore. The caller must be a metastore admin or have
|
|
11724
11674
|
the **CREATE_EXTERNAL_LOCATION** privilege on both the metastore and the associated storage
|
|
11725
11675
|
credential.
|
|
11726
11676
|
|
|
@@ -11779,9 +11729,7 @@ class ExternalLocationsAPI:
|
|
|
11779
11729
|
return ExternalLocationInfo.from_dict(res)
|
|
11780
11730
|
|
|
11781
11731
|
def delete(self, name: str, *, force: Optional[bool] = None):
|
|
11782
|
-
"""
|
|
11783
|
-
|
|
11784
|
-
Deletes the specified external location from the metastore. The caller must be the owner of the
|
|
11732
|
+
"""Deletes the specified external location from the metastore. The caller must be the owner of the
|
|
11785
11733
|
external location.
|
|
11786
11734
|
|
|
11787
11735
|
:param name: str
|
|
@@ -11802,9 +11750,7 @@ class ExternalLocationsAPI:
|
|
|
11802
11750
|
self._api.do("DELETE", f"/api/2.1/unity-catalog/external-locations/{name}", query=query, headers=headers)
|
|
11803
11751
|
|
|
11804
11752
|
def get(self, name: str, *, include_browse: Optional[bool] = None) -> ExternalLocationInfo:
|
|
11805
|
-
"""
|
|
11806
|
-
|
|
11807
|
-
Gets an external location from the metastore. The caller must be either a metastore admin, the owner
|
|
11753
|
+
"""Gets an external location from the metastore. The caller must be either a metastore admin, the owner
|
|
11808
11754
|
of the external location, or a user that has some privilege on the external location.
|
|
11809
11755
|
|
|
11810
11756
|
:param name: str
|
|
@@ -11833,9 +11779,7 @@ class ExternalLocationsAPI:
|
|
|
11833
11779
|
max_results: Optional[int] = None,
|
|
11834
11780
|
page_token: Optional[str] = None,
|
|
11835
11781
|
) -> Iterator[ExternalLocationInfo]:
|
|
11836
|
-
"""
|
|
11837
|
-
|
|
11838
|
-
Gets an array of external locations (__ExternalLocationInfo__ objects) from the metastore. The caller
|
|
11782
|
+
"""Gets an array of external locations (__ExternalLocationInfo__ objects) from the metastore. The caller
|
|
11839
11783
|
must be a metastore admin, the owner of the external location, or a user that has some privilege on
|
|
11840
11784
|
the external location. There is no guarantee of a specific ordering of the elements in the array.
|
|
11841
11785
|
|
|
@@ -11891,9 +11835,7 @@ class ExternalLocationsAPI:
|
|
|
11891
11835
|
skip_validation: Optional[bool] = None,
|
|
11892
11836
|
url: Optional[str] = None,
|
|
11893
11837
|
) -> ExternalLocationInfo:
|
|
11894
|
-
"""
|
|
11895
|
-
|
|
11896
|
-
Updates an external location in the metastore. The caller must be the owner of the external location,
|
|
11838
|
+
"""Updates an external location in the metastore. The caller must be the owner of the external location,
|
|
11897
11839
|
or be a metastore admin. In the second case, the admin can only update the name of the external
|
|
11898
11840
|
location.
|
|
11899
11841
|
|
|
@@ -11976,9 +11918,7 @@ class FunctionsAPI:
|
|
|
11976
11918
|
self._api = api_client
|
|
11977
11919
|
|
|
11978
11920
|
def create(self, function_info: CreateFunction) -> FunctionInfo:
|
|
11979
|
-
"""
|
|
11980
|
-
|
|
11981
|
-
**WARNING: This API is experimental and will change in future versions**
|
|
11921
|
+
"""**WARNING: This API is experimental and will change in future versions**
|
|
11982
11922
|
|
|
11983
11923
|
Creates a new function
|
|
11984
11924
|
|
|
@@ -12003,9 +11943,7 @@ class FunctionsAPI:
|
|
|
12003
11943
|
return FunctionInfo.from_dict(res)
|
|
12004
11944
|
|
|
12005
11945
|
def delete(self, name: str, *, force: Optional[bool] = None):
|
|
12006
|
-
"""
|
|
12007
|
-
|
|
12008
|
-
Deletes the function that matches the supplied name. For the deletion to succeed, the user must
|
|
11946
|
+
"""Deletes the function that matches the supplied name. For the deletion to succeed, the user must
|
|
12009
11947
|
satisfy one of the following conditions: - Is the owner of the function's parent catalog - Is the
|
|
12010
11948
|
owner of the function's parent schema and have the **USE_CATALOG** privilege on its parent catalog -
|
|
12011
11949
|
Is the owner of the function itself and have both the **USE_CATALOG** privilege on its parent catalog
|
|
@@ -12030,9 +11968,7 @@ class FunctionsAPI:
|
|
|
12030
11968
|
self._api.do("DELETE", f"/api/2.1/unity-catalog/functions/{name}", query=query, headers=headers)
|
|
12031
11969
|
|
|
12032
11970
|
def get(self, name: str, *, include_browse: Optional[bool] = None) -> FunctionInfo:
|
|
12033
|
-
"""
|
|
12034
|
-
|
|
12035
|
-
Gets a function from within a parent catalog and schema. For the fetch to succeed, the user must
|
|
11971
|
+
"""Gets a function from within a parent catalog and schema. For the fetch to succeed, the user must
|
|
12036
11972
|
satisfy one of the following requirements: - Is a metastore admin - Is an owner of the function's
|
|
12037
11973
|
parent catalog - Have the **USE_CATALOG** privilege on the function's parent catalog and be the owner
|
|
12038
11974
|
of the function - Have the **USE_CATALOG** privilege on the function's parent catalog, the
|
|
@@ -12068,9 +12004,7 @@ class FunctionsAPI:
|
|
|
12068
12004
|
max_results: Optional[int] = None,
|
|
12069
12005
|
page_token: Optional[str] = None,
|
|
12070
12006
|
) -> Iterator[FunctionInfo]:
|
|
12071
|
-
"""List functions.
|
|
12072
|
-
|
|
12073
|
-
List functions within the specified parent catalog and schema. If the user is a metastore admin, all
|
|
12007
|
+
"""List functions within the specified parent catalog and schema. If the user is a metastore admin, all
|
|
12074
12008
|
functions are returned in the output list. Otherwise, the user must have the **USE_CATALOG** privilege
|
|
12075
12009
|
on the catalog and the **USE_SCHEMA** privilege on the schema, and the output list contains only
|
|
12076
12010
|
functions for which either the user has the **EXECUTE** privilege or the user is the owner. There is
|
|
@@ -12119,9 +12053,7 @@ class FunctionsAPI:
|
|
|
12119
12053
|
query["page_token"] = json["next_page_token"]
|
|
12120
12054
|
|
|
12121
12055
|
def update(self, name: str, *, owner: Optional[str] = None) -> FunctionInfo:
|
|
12122
|
-
"""
|
|
12123
|
-
|
|
12124
|
-
Updates the function that matches the supplied name. Only the owner of the function can be updated. If
|
|
12056
|
+
"""Updates the function that matches the supplied name. Only the owner of the function can be updated. If
|
|
12125
12057
|
the user is not a metastore admin, the user must be a member of the group that is the new function
|
|
12126
12058
|
owner. - Is a metastore admin - Is the owner of the function's parent catalog - Is the owner of the
|
|
12127
12059
|
function's parent schema and has the **USE_CATALOG** privilege on its parent catalog - Is the owner of
|
|
@@ -12171,9 +12103,7 @@ class GrantsAPI:
|
|
|
12171
12103
|
page_token: Optional[str] = None,
|
|
12172
12104
|
principal: Optional[str] = None,
|
|
12173
12105
|
) -> GetPermissionsResponse:
|
|
12174
|
-
"""
|
|
12175
|
-
|
|
12176
|
-
Gets the permissions for a securable. Does not include inherited permissions.
|
|
12106
|
+
"""Gets the permissions for a securable. Does not include inherited permissions.
|
|
12177
12107
|
|
|
12178
12108
|
:param securable_type: str
|
|
12179
12109
|
Type of securable.
|
|
@@ -12222,9 +12152,7 @@ class GrantsAPI:
|
|
|
12222
12152
|
page_token: Optional[str] = None,
|
|
12223
12153
|
principal: Optional[str] = None,
|
|
12224
12154
|
) -> EffectivePermissionsList:
|
|
12225
|
-
"""
|
|
12226
|
-
|
|
12227
|
-
Gets the effective permissions for a securable. Includes inherited permissions from any parent
|
|
12155
|
+
"""Gets the effective permissions for a securable. Includes inherited permissions from any parent
|
|
12228
12156
|
securables.
|
|
12229
12157
|
|
|
12230
12158
|
:param securable_type: str
|
|
@@ -12273,9 +12201,7 @@ class GrantsAPI:
|
|
|
12273
12201
|
def update(
|
|
12274
12202
|
self, securable_type: str, full_name: str, *, changes: Optional[List[PermissionsChange]] = None
|
|
12275
12203
|
) -> UpdatePermissionsResponse:
|
|
12276
|
-
"""
|
|
12277
|
-
|
|
12278
|
-
Updates the permissions for a securable.
|
|
12204
|
+
"""Updates the permissions for a securable.
|
|
12279
12205
|
|
|
12280
12206
|
:param securable_type: str
|
|
12281
12207
|
Type of securable.
|
|
@@ -12317,9 +12243,7 @@ class MetastoresAPI:
|
|
|
12317
12243
|
self._api = api_client
|
|
12318
12244
|
|
|
12319
12245
|
def assign(self, workspace_id: int, metastore_id: str, default_catalog_name: str):
|
|
12320
|
-
"""
|
|
12321
|
-
|
|
12322
|
-
Creates a new metastore assignment. If an assignment for the same __workspace_id__ exists, it will be
|
|
12246
|
+
"""Creates a new metastore assignment. If an assignment for the same __workspace_id__ exists, it will be
|
|
12323
12247
|
overwritten by the new __metastore_id__ and __default_catalog_name__. The caller must be an account
|
|
12324
12248
|
admin.
|
|
12325
12249
|
|
|
@@ -12346,9 +12270,7 @@ class MetastoresAPI:
|
|
|
12346
12270
|
self._api.do("PUT", f"/api/2.1/unity-catalog/workspaces/{workspace_id}/metastore", body=body, headers=headers)
|
|
12347
12271
|
|
|
12348
12272
|
def create(self, name: str, *, region: Optional[str] = None, storage_root: Optional[str] = None) -> MetastoreInfo:
|
|
12349
|
-
"""
|
|
12350
|
-
|
|
12351
|
-
Creates a new metastore based on a provided name and optional storage root path. By default (if the
|
|
12273
|
+
"""Creates a new metastore based on a provided name and optional storage root path. By default (if the
|
|
12352
12274
|
__owner__ field is not set), the owner of the new metastore is the user calling the
|
|
12353
12275
|
__createMetastore__ API. If the __owner__ field is set to the empty string (**""**), the ownership is
|
|
12354
12276
|
assigned to the System User instead.
|
|
@@ -12378,9 +12300,7 @@ class MetastoresAPI:
|
|
|
12378
12300
|
return MetastoreInfo.from_dict(res)
|
|
12379
12301
|
|
|
12380
12302
|
def current(self) -> MetastoreAssignment:
|
|
12381
|
-
"""
|
|
12382
|
-
|
|
12383
|
-
Gets the metastore assignment for the workspace being accessed.
|
|
12303
|
+
"""Gets the metastore assignment for the workspace being accessed.
|
|
12384
12304
|
|
|
12385
12305
|
:returns: :class:`MetastoreAssignment`
|
|
12386
12306
|
"""
|
|
@@ -12393,9 +12313,7 @@ class MetastoresAPI:
|
|
|
12393
12313
|
return MetastoreAssignment.from_dict(res)
|
|
12394
12314
|
|
|
12395
12315
|
def delete(self, id: str, *, force: Optional[bool] = None):
|
|
12396
|
-
"""
|
|
12397
|
-
|
|
12398
|
-
Deletes a metastore. The caller must be a metastore admin.
|
|
12316
|
+
"""Deletes a metastore. The caller must be a metastore admin.
|
|
12399
12317
|
|
|
12400
12318
|
:param id: str
|
|
12401
12319
|
Unique ID of the metastore.
|
|
@@ -12415,9 +12333,7 @@ class MetastoresAPI:
|
|
|
12415
12333
|
self._api.do("DELETE", f"/api/2.1/unity-catalog/metastores/{id}", query=query, headers=headers)
|
|
12416
12334
|
|
|
12417
12335
|
def get(self, id: str) -> MetastoreInfo:
|
|
12418
|
-
"""
|
|
12419
|
-
|
|
12420
|
-
Gets a metastore that matches the supplied ID. The caller must be a metastore admin to retrieve this
|
|
12336
|
+
"""Gets a metastore that matches the supplied ID. The caller must be a metastore admin to retrieve this
|
|
12421
12337
|
info.
|
|
12422
12338
|
|
|
12423
12339
|
:param id: str
|
|
@@ -12434,9 +12350,7 @@ class MetastoresAPI:
|
|
|
12434
12350
|
return MetastoreInfo.from_dict(res)
|
|
12435
12351
|
|
|
12436
12352
|
def list(self, *, max_results: Optional[int] = None, page_token: Optional[str] = None) -> Iterator[MetastoreInfo]:
|
|
12437
|
-
"""
|
|
12438
|
-
|
|
12439
|
-
Gets an array of the available metastores (as __MetastoreInfo__ objects). The caller must be an admin
|
|
12353
|
+
"""Gets an array of the available metastores (as __MetastoreInfo__ objects). The caller must be an admin
|
|
12440
12354
|
to retrieve this info. There is no guarantee of a specific ordering of the elements in the array.
|
|
12441
12355
|
|
|
12442
12356
|
:param max_results: int (optional)
|
|
@@ -12472,9 +12386,7 @@ class MetastoresAPI:
|
|
|
12472
12386
|
query["page_token"] = json["next_page_token"]
|
|
12473
12387
|
|
|
12474
12388
|
def summary(self) -> GetMetastoreSummaryResponse:
|
|
12475
|
-
"""
|
|
12476
|
-
|
|
12477
|
-
Gets information about a metastore. This summary includes the storage credential, the cloud vendor,
|
|
12389
|
+
"""Gets information about a metastore. This summary includes the storage credential, the cloud vendor,
|
|
12478
12390
|
the cloud region, and the global metastore ID.
|
|
12479
12391
|
|
|
12480
12392
|
:returns: :class:`GetMetastoreSummaryResponse`
|
|
@@ -12488,9 +12400,7 @@ class MetastoresAPI:
|
|
|
12488
12400
|
return GetMetastoreSummaryResponse.from_dict(res)
|
|
12489
12401
|
|
|
12490
12402
|
def unassign(self, workspace_id: int, metastore_id: str):
|
|
12491
|
-
"""
|
|
12492
|
-
|
|
12493
|
-
Deletes a metastore assignment. The caller must be an account administrator.
|
|
12403
|
+
"""Deletes a metastore assignment. The caller must be an account administrator.
|
|
12494
12404
|
|
|
12495
12405
|
:param workspace_id: int
|
|
12496
12406
|
A workspace ID.
|
|
@@ -12523,9 +12433,7 @@ class MetastoresAPI:
|
|
|
12523
12433
|
privilege_model_version: Optional[str] = None,
|
|
12524
12434
|
storage_root_credential_id: Optional[str] = None,
|
|
12525
12435
|
) -> MetastoreInfo:
|
|
12526
|
-
"""
|
|
12527
|
-
|
|
12528
|
-
Updates information for a specific metastore. The caller must be a metastore admin. If the __owner__
|
|
12436
|
+
"""Updates information for a specific metastore. The caller must be a metastore admin. If the __owner__
|
|
12529
12437
|
field is set to the empty string (**""**), the ownership is updated to the System User.
|
|
12530
12438
|
|
|
12531
12439
|
:param id: str
|
|
@@ -12576,9 +12484,7 @@ class MetastoresAPI:
|
|
|
12576
12484
|
def update_assignment(
|
|
12577
12485
|
self, workspace_id: int, *, default_catalog_name: Optional[str] = None, metastore_id: Optional[str] = None
|
|
12578
12486
|
):
|
|
12579
|
-
"""
|
|
12580
|
-
|
|
12581
|
-
Updates a metastore assignment. This operation can be used to update __metastore_id__ or
|
|
12487
|
+
"""Updates a metastore assignment. This operation can be used to update __metastore_id__ or
|
|
12582
12488
|
__default_catalog_name__ for a specified Workspace, if the Workspace is already assigned a metastore.
|
|
12583
12489
|
The caller must be an account admin to update __metastore_id__; otherwise, the caller can be a
|
|
12584
12490
|
Workspace admin.
|
|
@@ -12618,9 +12524,7 @@ class ModelVersionsAPI:
|
|
|
12618
12524
|
self._api = api_client
|
|
12619
12525
|
|
|
12620
12526
|
def delete(self, full_name: str, version: int):
|
|
12621
|
-
"""
|
|
12622
|
-
|
|
12623
|
-
Deletes a model version from the specified registered model. Any aliases assigned to the model version
|
|
12527
|
+
"""Deletes a model version from the specified registered model. Any aliases assigned to the model version
|
|
12624
12528
|
will also be deleted.
|
|
12625
12529
|
|
|
12626
12530
|
The caller must be a metastore admin or an owner of the parent registered model. For the latter case,
|
|
@@ -12647,9 +12551,7 @@ class ModelVersionsAPI:
|
|
|
12647
12551
|
include_aliases: Optional[bool] = None,
|
|
12648
12552
|
include_browse: Optional[bool] = None,
|
|
12649
12553
|
) -> ModelVersionInfo:
|
|
12650
|
-
"""Get a
|
|
12651
|
-
|
|
12652
|
-
Get a model version.
|
|
12554
|
+
"""Get a model version.
|
|
12653
12555
|
|
|
12654
12556
|
The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on) the parent
|
|
12655
12557
|
registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG**
|
|
@@ -12683,9 +12585,7 @@ class ModelVersionsAPI:
|
|
|
12683
12585
|
return ModelVersionInfo.from_dict(res)
|
|
12684
12586
|
|
|
12685
12587
|
def get_by_alias(self, full_name: str, alias: str, *, include_aliases: Optional[bool] = None) -> ModelVersionInfo:
|
|
12686
|
-
"""Get
|
|
12687
|
-
|
|
12688
|
-
Get a model version by alias.
|
|
12588
|
+
"""Get a model version by alias.
|
|
12689
12589
|
|
|
12690
12590
|
The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on) the
|
|
12691
12591
|
registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG**
|
|
@@ -12721,9 +12621,7 @@ class ModelVersionsAPI:
|
|
|
12721
12621
|
max_results: Optional[int] = None,
|
|
12722
12622
|
page_token: Optional[str] = None,
|
|
12723
12623
|
) -> Iterator[ModelVersionInfo]:
|
|
12724
|
-
"""List
|
|
12725
|
-
|
|
12726
|
-
List model versions. You can list model versions under a particular schema, or list all model versions
|
|
12624
|
+
"""List model versions. You can list model versions under a particular schema, or list all model versions
|
|
12727
12625
|
in the current metastore.
|
|
12728
12626
|
|
|
12729
12627
|
The returned models are filtered based on the privileges of the calling user. For example, the
|
|
@@ -12775,9 +12673,7 @@ class ModelVersionsAPI:
|
|
|
12775
12673
|
query["page_token"] = json["next_page_token"]
|
|
12776
12674
|
|
|
12777
12675
|
def update(self, full_name: str, version: int, *, comment: Optional[str] = None) -> ModelVersionInfo:
|
|
12778
|
-
"""
|
|
12779
|
-
|
|
12780
|
-
Updates the specified model version.
|
|
12676
|
+
"""Updates the specified model version.
|
|
12781
12677
|
|
|
12782
12678
|
The caller must be a metastore admin or an owner of the parent registered model. For the latter case,
|
|
12783
12679
|
the caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the
|
|
@@ -12844,9 +12740,7 @@ class OnlineTablesAPI:
|
|
|
12844
12740
|
raise TimeoutError(f"timed out after {timeout}: {status_message}")
|
|
12845
12741
|
|
|
12846
12742
|
def create(self, table: OnlineTable) -> Wait[OnlineTable]:
|
|
12847
|
-
"""Create
|
|
12848
|
-
|
|
12849
|
-
Create a new Online Table.
|
|
12743
|
+
"""Create a new Online Table.
|
|
12850
12744
|
|
|
12851
12745
|
:param table: :class:`OnlineTable`
|
|
12852
12746
|
Online Table information.
|
|
@@ -12870,9 +12764,7 @@ class OnlineTablesAPI:
|
|
|
12870
12764
|
return self.create(table=table).result(timeout=timeout)
|
|
12871
12765
|
|
|
12872
12766
|
def delete(self, name: str):
|
|
12873
|
-
"""Delete an
|
|
12874
|
-
|
|
12875
|
-
Delete an online table. Warning: This will delete all the data in the online table. If the source
|
|
12767
|
+
"""Delete an online table. Warning: This will delete all the data in the online table. If the source
|
|
12876
12768
|
Delta table was deleted or modified since this Online Table was created, this will lose the data
|
|
12877
12769
|
forever!
|
|
12878
12770
|
|
|
@@ -12889,9 +12781,7 @@ class OnlineTablesAPI:
|
|
|
12889
12781
|
self._api.do("DELETE", f"/api/2.0/online-tables/{name}", headers=headers)
|
|
12890
12782
|
|
|
12891
12783
|
def get(self, name: str) -> OnlineTable:
|
|
12892
|
-
"""Get an
|
|
12893
|
-
|
|
12894
|
-
Get information about an existing online table and its status.
|
|
12784
|
+
"""Get information about an existing online table and its status.
|
|
12895
12785
|
|
|
12896
12786
|
:param name: str
|
|
12897
12787
|
Full three-part (catalog, schema, table) name of the table.
|
|
@@ -12919,9 +12809,7 @@ class QualityMonitorsAPI:
|
|
|
12919
12809
|
self._api = api_client
|
|
12920
12810
|
|
|
12921
12811
|
def cancel_refresh(self, table_name: str, refresh_id: str):
|
|
12922
|
-
"""Cancel refresh.
|
|
12923
|
-
|
|
12924
|
-
Cancel an active monitor refresh for the given refresh ID.
|
|
12812
|
+
"""Cancel an active monitor refresh for the given refresh ID.
|
|
12925
12813
|
|
|
12926
12814
|
The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the
|
|
12927
12815
|
table's parent catalog and be an owner of the table's parent schema 3. have the following permissions:
|
|
@@ -12962,9 +12850,7 @@ class QualityMonitorsAPI:
|
|
|
12962
12850
|
time_series: Optional[MonitorTimeSeries] = None,
|
|
12963
12851
|
warehouse_id: Optional[str] = None,
|
|
12964
12852
|
) -> MonitorInfo:
|
|
12965
|
-
"""
|
|
12966
|
-
|
|
12967
|
-
Creates a new monitor for the specified table.
|
|
12853
|
+
"""Creates a new monitor for the specified table.
|
|
12968
12854
|
|
|
12969
12855
|
The caller must either: 1. be an owner of the table's parent catalog, have **USE_SCHEMA** on the
|
|
12970
12856
|
table's parent schema, and have **SELECT** access on the table 2. have **USE_CATALOG** on the table's
|
|
@@ -13046,9 +12932,7 @@ class QualityMonitorsAPI:
|
|
|
13046
12932
|
return MonitorInfo.from_dict(res)
|
|
13047
12933
|
|
|
13048
12934
|
def delete(self, table_name: str):
|
|
13049
|
-
"""
|
|
13050
|
-
|
|
13051
|
-
Deletes a monitor for the specified table.
|
|
12935
|
+
"""Deletes a monitor for the specified table.
|
|
13052
12936
|
|
|
13053
12937
|
The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the
|
|
13054
12938
|
table's parent catalog and be an owner of the table's parent schema 3. have the following permissions:
|
|
@@ -13071,9 +12955,7 @@ class QualityMonitorsAPI:
|
|
|
13071
12955
|
self._api.do("DELETE", f"/api/2.1/unity-catalog/tables/{table_name}/monitor", headers=headers)
|
|
13072
12956
|
|
|
13073
12957
|
def get(self, table_name: str) -> MonitorInfo:
|
|
13074
|
-
"""
|
|
13075
|
-
|
|
13076
|
-
Gets a monitor for the specified table.
|
|
12958
|
+
"""Gets a monitor for the specified table.
|
|
13077
12959
|
|
|
13078
12960
|
The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the
|
|
13079
12961
|
table's parent catalog and be an owner of the table's parent schema. 3. have the following
|
|
@@ -13098,9 +12980,7 @@ class QualityMonitorsAPI:
|
|
|
13098
12980
|
return MonitorInfo.from_dict(res)
|
|
13099
12981
|
|
|
13100
12982
|
def get_refresh(self, table_name: str, refresh_id: str) -> MonitorRefreshInfo:
|
|
13101
|
-
"""
|
|
13102
|
-
|
|
13103
|
-
Gets info about a specific monitor refresh using the given refresh ID.
|
|
12983
|
+
"""Gets info about a specific monitor refresh using the given refresh ID.
|
|
13104
12984
|
|
|
13105
12985
|
The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the
|
|
13106
12986
|
table's parent catalog and be an owner of the table's parent schema 3. have the following permissions:
|
|
@@ -13127,9 +13007,7 @@ class QualityMonitorsAPI:
|
|
|
13127
13007
|
return MonitorRefreshInfo.from_dict(res)
|
|
13128
13008
|
|
|
13129
13009
|
def list_refreshes(self, table_name: str) -> MonitorRefreshListResponse:
|
|
13130
|
-
"""
|
|
13131
|
-
|
|
13132
|
-
Gets an array containing the history of the most recent refreshes (up to 25) for this table.
|
|
13010
|
+
"""Gets an array containing the history of the most recent refreshes (up to 25) for this table.
|
|
13133
13011
|
|
|
13134
13012
|
The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the
|
|
13135
13013
|
table's parent catalog and be an owner of the table's parent schema 3. have the following permissions:
|
|
@@ -13154,9 +13032,7 @@ class QualityMonitorsAPI:
|
|
|
13154
13032
|
def regenerate_dashboard(
|
|
13155
13033
|
self, table_name: str, *, warehouse_id: Optional[str] = None
|
|
13156
13034
|
) -> RegenerateDashboardResponse:
|
|
13157
|
-
"""
|
|
13158
|
-
|
|
13159
|
-
Regenerates the monitoring dashboard for the specified table.
|
|
13035
|
+
"""Regenerates the monitoring dashboard for the specified table.
|
|
13160
13036
|
|
|
13161
13037
|
The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the
|
|
13162
13038
|
table's parent catalog and be an owner of the table's parent schema 3. have the following permissions:
|
|
@@ -13188,9 +13064,7 @@ class QualityMonitorsAPI:
|
|
|
13188
13064
|
return RegenerateDashboardResponse.from_dict(res)
|
|
13189
13065
|
|
|
13190
13066
|
def run_refresh(self, table_name: str) -> MonitorRefreshInfo:
|
|
13191
|
-
"""
|
|
13192
|
-
|
|
13193
|
-
Queues a metric refresh on the monitor for the specified table. The refresh will execute in the
|
|
13067
|
+
"""Queues a metric refresh on the monitor for the specified table. The refresh will execute in the
|
|
13194
13068
|
background.
|
|
13195
13069
|
|
|
13196
13070
|
The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the
|
|
@@ -13229,9 +13103,7 @@ class QualityMonitorsAPI:
|
|
|
13229
13103
|
snapshot: Optional[MonitorSnapshot] = None,
|
|
13230
13104
|
time_series: Optional[MonitorTimeSeries] = None,
|
|
13231
13105
|
) -> MonitorInfo:
|
|
13232
|
-
"""
|
|
13233
|
-
|
|
13234
|
-
Updates a monitor for the specified table.
|
|
13106
|
+
"""Updates a monitor for the specified table.
|
|
13235
13107
|
|
|
13236
13108
|
The caller must either: 1. be an owner of the table's parent catalog 2. have **USE_CATALOG** on the
|
|
13237
13109
|
table's parent catalog and be an owner of the table's parent schema 3. have the following permissions:
|
|
@@ -13345,9 +13217,7 @@ class RegisteredModelsAPI:
|
|
|
13345
13217
|
comment: Optional[str] = None,
|
|
13346
13218
|
storage_location: Optional[str] = None,
|
|
13347
13219
|
) -> RegisteredModelInfo:
|
|
13348
|
-
"""
|
|
13349
|
-
|
|
13350
|
-
Creates a new registered model in Unity Catalog.
|
|
13220
|
+
"""Creates a new registered model in Unity Catalog.
|
|
13351
13221
|
|
|
13352
13222
|
File storage for model versions in the registered model will be located in the default location which
|
|
13353
13223
|
is specified by the parent schema, or the parent catalog, or the Metastore.
|
|
@@ -13390,9 +13260,7 @@ class RegisteredModelsAPI:
|
|
|
13390
13260
|
return RegisteredModelInfo.from_dict(res)
|
|
13391
13261
|
|
|
13392
13262
|
def delete(self, full_name: str):
|
|
13393
|
-
"""
|
|
13394
|
-
|
|
13395
|
-
Deletes a registered model and all its model versions from the specified parent catalog and schema.
|
|
13263
|
+
"""Deletes a registered model and all its model versions from the specified parent catalog and schema.
|
|
13396
13264
|
|
|
13397
13265
|
The caller must be a metastore admin or an owner of the registered model. For the latter case, the
|
|
13398
13266
|
caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the
|
|
@@ -13409,9 +13277,7 @@ class RegisteredModelsAPI:
|
|
|
13409
13277
|
self._api.do("DELETE", f"/api/2.1/unity-catalog/models/{full_name}", headers=headers)
|
|
13410
13278
|
|
|
13411
13279
|
def delete_alias(self, full_name: str, alias: str):
|
|
13412
|
-
"""
|
|
13413
|
-
|
|
13414
|
-
Deletes a registered model alias.
|
|
13280
|
+
"""Deletes a registered model alias.
|
|
13415
13281
|
|
|
13416
13282
|
The caller must be a metastore admin or an owner of the registered model. For the latter case, the
|
|
13417
13283
|
caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the
|
|
@@ -13432,9 +13298,7 @@ class RegisteredModelsAPI:
|
|
|
13432
13298
|
def get(
|
|
13433
13299
|
self, full_name: str, *, include_aliases: Optional[bool] = None, include_browse: Optional[bool] = None
|
|
13434
13300
|
) -> RegisteredModelInfo:
|
|
13435
|
-
"""Get a
|
|
13436
|
-
|
|
13437
|
-
Get a registered model.
|
|
13301
|
+
"""Get a registered model.
|
|
13438
13302
|
|
|
13439
13303
|
The caller must be a metastore admin or an owner of (or have the **EXECUTE** privilege on) the
|
|
13440
13304
|
registered model. For the latter case, the caller must also be the owner or have the **USE_CATALOG**
|
|
@@ -13472,9 +13336,7 @@ class RegisteredModelsAPI:
|
|
|
13472
13336
|
page_token: Optional[str] = None,
|
|
13473
13337
|
schema_name: Optional[str] = None,
|
|
13474
13338
|
) -> Iterator[RegisteredModelInfo]:
|
|
13475
|
-
"""List
|
|
13476
|
-
|
|
13477
|
-
List registered models. You can list registered models under a particular schema, or list all
|
|
13339
|
+
"""List registered models. You can list registered models under a particular schema, or list all
|
|
13478
13340
|
registered models in the current metastore.
|
|
13479
13341
|
|
|
13480
13342
|
The returned models are filtered based on the privileges of the calling user. For example, the
|
|
@@ -13539,9 +13401,7 @@ class RegisteredModelsAPI:
|
|
|
13539
13401
|
query["page_token"] = json["next_page_token"]
|
|
13540
13402
|
|
|
13541
13403
|
def set_alias(self, full_name: str, alias: str, version_num: int) -> RegisteredModelAlias:
|
|
13542
|
-
"""Set
|
|
13543
|
-
|
|
13544
|
-
Set an alias on the specified registered model.
|
|
13404
|
+
"""Set an alias on the specified registered model.
|
|
13545
13405
|
|
|
13546
13406
|
The caller must be a metastore admin or an owner of the registered model. For the latter case, the
|
|
13547
13407
|
caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the
|
|
@@ -13577,9 +13437,7 @@ class RegisteredModelsAPI:
|
|
|
13577
13437
|
new_name: Optional[str] = None,
|
|
13578
13438
|
owner: Optional[str] = None,
|
|
13579
13439
|
) -> RegisteredModelInfo:
|
|
13580
|
-
"""
|
|
13581
|
-
|
|
13582
|
-
Updates the specified registered model.
|
|
13440
|
+
"""Updates the specified registered model.
|
|
13583
13441
|
|
|
13584
13442
|
The caller must be a metastore admin or an owner of the registered model. For the latter case, the
|
|
13585
13443
|
caller must also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the
|
|
@@ -13627,9 +13485,7 @@ class ResourceQuotasAPI:
|
|
|
13627
13485
|
self._api = api_client
|
|
13628
13486
|
|
|
13629
13487
|
def get_quota(self, parent_securable_type: str, parent_full_name: str, quota_name: str) -> GetQuotaResponse:
|
|
13630
|
-
"""
|
|
13631
|
-
|
|
13632
|
-
The GetQuota API returns usage information for a single resource quota, defined as a child-parent
|
|
13488
|
+
"""The GetQuota API returns usage information for a single resource quota, defined as a child-parent
|
|
13633
13489
|
pair. This API also refreshes the quota count if it is out of date. Refreshes are triggered
|
|
13634
13490
|
asynchronously. The updated count might not be returned in the first call.
|
|
13635
13491
|
|
|
@@ -13657,9 +13513,7 @@ class ResourceQuotasAPI:
|
|
|
13657
13513
|
def list_quotas(
|
|
13658
13514
|
self, *, max_results: Optional[int] = None, page_token: Optional[str] = None
|
|
13659
13515
|
) -> Iterator[QuotaInfo]:
|
|
13660
|
-
"""
|
|
13661
|
-
|
|
13662
|
-
ListQuotas returns all quota values under the metastore. There are no SLAs on the freshness of the
|
|
13516
|
+
"""ListQuotas returns all quota values under the metastore. There are no SLAs on the freshness of the
|
|
13663
13517
|
counts returned. This API does not trigger a refresh of quota counts.
|
|
13664
13518
|
|
|
13665
13519
|
:param max_results: int (optional)
|
|
@@ -13709,9 +13563,7 @@ class SchemasAPI:
|
|
|
13709
13563
|
properties: Optional[Dict[str, str]] = None,
|
|
13710
13564
|
storage_root: Optional[str] = None,
|
|
13711
13565
|
) -> SchemaInfo:
|
|
13712
|
-
"""
|
|
13713
|
-
|
|
13714
|
-
Creates a new schema for catalog in the Metatastore. The caller must be a metastore admin, or have the
|
|
13566
|
+
"""Creates a new schema for catalog in the Metatastore. The caller must be a metastore admin, or have the
|
|
13715
13567
|
**CREATE_SCHEMA** privilege in the parent catalog.
|
|
13716
13568
|
|
|
13717
13569
|
:param name: str
|
|
@@ -13747,9 +13599,7 @@ class SchemasAPI:
|
|
|
13747
13599
|
return SchemaInfo.from_dict(res)
|
|
13748
13600
|
|
|
13749
13601
|
def delete(self, full_name: str, *, force: Optional[bool] = None):
|
|
13750
|
-
"""
|
|
13751
|
-
|
|
13752
|
-
Deletes the specified schema from the parent catalog. The caller must be the owner of the schema or an
|
|
13602
|
+
"""Deletes the specified schema from the parent catalog. The caller must be the owner of the schema or an
|
|
13753
13603
|
owner of the parent catalog.
|
|
13754
13604
|
|
|
13755
13605
|
:param full_name: str
|
|
@@ -13770,9 +13620,7 @@ class SchemasAPI:
|
|
|
13770
13620
|
self._api.do("DELETE", f"/api/2.1/unity-catalog/schemas/{full_name}", query=query, headers=headers)
|
|
13771
13621
|
|
|
13772
13622
|
def get(self, full_name: str, *, include_browse: Optional[bool] = None) -> SchemaInfo:
|
|
13773
|
-
"""
|
|
13774
|
-
|
|
13775
|
-
Gets the specified schema within the metastore. The caller must be a metastore admin, the owner of the
|
|
13623
|
+
"""Gets the specified schema within the metastore. The caller must be a metastore admin, the owner of the
|
|
13776
13624
|
schema, or a user that has the **USE_SCHEMA** privilege on the schema.
|
|
13777
13625
|
|
|
13778
13626
|
:param full_name: str
|
|
@@ -13802,9 +13650,7 @@ class SchemasAPI:
|
|
|
13802
13650
|
max_results: Optional[int] = None,
|
|
13803
13651
|
page_token: Optional[str] = None,
|
|
13804
13652
|
) -> Iterator[SchemaInfo]:
|
|
13805
|
-
"""
|
|
13806
|
-
|
|
13807
|
-
Gets an array of schemas for a catalog in the metastore. If the caller is the metastore admin or the
|
|
13653
|
+
"""Gets an array of schemas for a catalog in the metastore. If the caller is the metastore admin or the
|
|
13808
13654
|
owner of the parent catalog, all schemas for the catalog will be retrieved. Otherwise, only schemas
|
|
13809
13655
|
owned by the caller (or for which the caller has the **USE_SCHEMA** privilege) will be retrieved.
|
|
13810
13656
|
There is no guarantee of a specific ordering of the elements in the array.
|
|
@@ -13857,9 +13703,7 @@ class SchemasAPI:
|
|
|
13857
13703
|
owner: Optional[str] = None,
|
|
13858
13704
|
properties: Optional[Dict[str, str]] = None,
|
|
13859
13705
|
) -> SchemaInfo:
|
|
13860
|
-
"""
|
|
13861
|
-
|
|
13862
|
-
Updates a schema for a catalog. The caller must be the owner of the schema or a metastore admin. If
|
|
13706
|
+
"""Updates a schema for a catalog. The caller must be the owner of the schema or a metastore admin. If
|
|
13863
13707
|
the caller is a metastore admin, only the __owner__ field can be changed in the update. If the
|
|
13864
13708
|
__name__ field must be updated, the caller must be a metastore admin or have the **CREATE_SCHEMA**
|
|
13865
13709
|
privilege on the parent catalog.
|
|
@@ -13927,12 +13771,14 @@ class StorageCredentialsAPI:
|
|
|
13927
13771
|
read_only: Optional[bool] = None,
|
|
13928
13772
|
skip_validation: Optional[bool] = None,
|
|
13929
13773
|
) -> StorageCredentialInfo:
|
|
13930
|
-
"""
|
|
13774
|
+
"""Creates a new storage credential.
|
|
13931
13775
|
|
|
13932
|
-
|
|
13776
|
+
The caller must be a metastore admin or have the **CREATE_STORAGE_CREDENTIAL** privilege on the
|
|
13777
|
+
metastore.
|
|
13933
13778
|
|
|
13934
13779
|
:param name: str
|
|
13935
|
-
The credential name. The name must be unique within the
|
|
13780
|
+
The credential name. The name must be unique among storage and service credentials within the
|
|
13781
|
+
metastore.
|
|
13936
13782
|
:param aws_iam_role: :class:`AwsIamRoleRequest` (optional)
|
|
13937
13783
|
The AWS IAM role configuration.
|
|
13938
13784
|
:param azure_managed_identity: :class:`AzureManagedIdentityRequest` (optional)
|
|
@@ -13946,7 +13792,8 @@ class StorageCredentialsAPI:
|
|
|
13946
13792
|
:param databricks_gcp_service_account: :class:`DatabricksGcpServiceAccountRequest` (optional)
|
|
13947
13793
|
The Databricks managed GCP service account configuration.
|
|
13948
13794
|
:param read_only: bool (optional)
|
|
13949
|
-
Whether the
|
|
13795
|
+
Whether the credential is usable only for read operations. Only applicable when purpose is
|
|
13796
|
+
**STORAGE**.
|
|
13950
13797
|
:param skip_validation: bool (optional)
|
|
13951
13798
|
Supplying true to this argument skips validation of the created credential.
|
|
13952
13799
|
|
|
@@ -13980,15 +13827,14 @@ class StorageCredentialsAPI:
|
|
|
13980
13827
|
return StorageCredentialInfo.from_dict(res)
|
|
13981
13828
|
|
|
13982
13829
|
def delete(self, name: str, *, force: Optional[bool] = None):
|
|
13983
|
-
"""
|
|
13984
|
-
|
|
13985
|
-
Deletes a storage credential from the metastore. The caller must be an owner of the storage
|
|
13830
|
+
"""Deletes a storage credential from the metastore. The caller must be an owner of the storage
|
|
13986
13831
|
credential.
|
|
13987
13832
|
|
|
13988
13833
|
:param name: str
|
|
13989
13834
|
Name of the storage credential.
|
|
13990
13835
|
:param force: bool (optional)
|
|
13991
|
-
Force
|
|
13836
|
+
Force an update even if there are dependent external locations or external tables (when purpose is
|
|
13837
|
+
**STORAGE**) or dependent services (when purpose is **SERVICE**).
|
|
13992
13838
|
|
|
13993
13839
|
|
|
13994
13840
|
"""
|
|
@@ -14003,9 +13849,7 @@ class StorageCredentialsAPI:
|
|
|
14003
13849
|
self._api.do("DELETE", f"/api/2.1/unity-catalog/storage-credentials/{name}", query=query, headers=headers)
|
|
14004
13850
|
|
|
14005
13851
|
def get(self, name: str) -> StorageCredentialInfo:
|
|
14006
|
-
"""
|
|
14007
|
-
|
|
14008
|
-
Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the
|
|
13852
|
+
"""Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the
|
|
14009
13853
|
storage credential, or have some permission on the storage credential.
|
|
14010
13854
|
|
|
14011
13855
|
:param name: str
|
|
@@ -14024,9 +13868,7 @@ class StorageCredentialsAPI:
|
|
|
14024
13868
|
def list(
|
|
14025
13869
|
self, *, max_results: Optional[int] = None, page_token: Optional[str] = None
|
|
14026
13870
|
) -> Iterator[StorageCredentialInfo]:
|
|
14027
|
-
"""
|
|
14028
|
-
|
|
14029
|
-
Gets an array of storage credentials (as __StorageCredentialInfo__ objects). The array is limited to
|
|
13871
|
+
"""Gets an array of storage credentials (as __StorageCredentialInfo__ objects). The array is limited to
|
|
14030
13872
|
only those storage credentials the caller has permission to access. If the caller is a metastore
|
|
14031
13873
|
admin, retrieval of credentials is unrestricted. There is no guarantee of a specific ordering of the
|
|
14032
13874
|
elements in the array.
|
|
@@ -14052,8 +13894,6 @@ class StorageCredentialsAPI:
|
|
|
14052
13894
|
"Accept": "application/json",
|
|
14053
13895
|
}
|
|
14054
13896
|
|
|
14055
|
-
if "max_results" not in query:
|
|
14056
|
-
query["max_results"] = 0
|
|
14057
13897
|
while True:
|
|
14058
13898
|
json = self._api.do("GET", "/api/2.1/unity-catalog/storage-credentials", query=query, headers=headers)
|
|
14059
13899
|
if "storage_credentials" in json:
|
|
@@ -14080,9 +13920,10 @@ class StorageCredentialsAPI:
|
|
|
14080
13920
|
read_only: Optional[bool] = None,
|
|
14081
13921
|
skip_validation: Optional[bool] = None,
|
|
14082
13922
|
) -> StorageCredentialInfo:
|
|
14083
|
-
"""
|
|
13923
|
+
"""Updates a storage credential on the metastore.
|
|
14084
13924
|
|
|
14085
|
-
|
|
13925
|
+
The caller must be the owner of the storage credential or a metastore admin. If the caller is a
|
|
13926
|
+
metastore admin, only the **owner** field can be changed.
|
|
14086
13927
|
|
|
14087
13928
|
:param name: str
|
|
14088
13929
|
Name of the storage credential.
|
|
@@ -14101,12 +13942,14 @@ class StorageCredentialsAPI:
|
|
|
14101
13942
|
:param force: bool (optional)
|
|
14102
13943
|
Force update even if there are dependent external locations or external tables.
|
|
14103
13944
|
:param isolation_mode: :class:`IsolationMode` (optional)
|
|
13945
|
+
Whether the current securable is accessible from all workspaces or a specific set of workspaces.
|
|
14104
13946
|
:param new_name: str (optional)
|
|
14105
13947
|
New name for the storage credential.
|
|
14106
13948
|
:param owner: str (optional)
|
|
14107
13949
|
Username of current owner of credential.
|
|
14108
13950
|
:param read_only: bool (optional)
|
|
14109
|
-
Whether the
|
|
13951
|
+
Whether the credential is usable only for read operations. Only applicable when purpose is
|
|
13952
|
+
**STORAGE**.
|
|
14110
13953
|
:param skip_validation: bool (optional)
|
|
14111
13954
|
Supplying true to this argument skips validation of the updated credential.
|
|
14112
13955
|
|
|
@@ -14158,9 +14001,7 @@ class StorageCredentialsAPI:
|
|
|
14158
14001
|
storage_credential_name: Optional[str] = None,
|
|
14159
14002
|
url: Optional[str] = None,
|
|
14160
14003
|
) -> ValidateStorageCredentialResponse:
|
|
14161
|
-
"""
|
|
14162
|
-
|
|
14163
|
-
Validates a storage credential. At least one of __external_location_name__ and __url__ need to be
|
|
14004
|
+
"""Validates a storage credential. At least one of __external_location_name__ and __url__ need to be
|
|
14164
14005
|
provided. If only one of them is provided, it will be used for validation. And if both are provided,
|
|
14165
14006
|
the __url__ will be used for validation, and __external_location_name__ will be ignored when checking
|
|
14166
14007
|
overlapping urls.
|
|
@@ -14185,7 +14026,7 @@ class StorageCredentialsAPI:
|
|
|
14185
14026
|
:param read_only: bool (optional)
|
|
14186
14027
|
Whether the storage credential is only usable for read operations.
|
|
14187
14028
|
:param storage_credential_name: str (optional)
|
|
14188
|
-
The name of
|
|
14029
|
+
Required. The name of an existing credential or long-lived cloud credential to validate.
|
|
14189
14030
|
:param url: str (optional)
|
|
14190
14031
|
The external location url to validate.
|
|
14191
14032
|
|
|
@@ -14227,9 +14068,7 @@ class SystemSchemasAPI:
|
|
|
14227
14068
|
self._api = api_client
|
|
14228
14069
|
|
|
14229
14070
|
def disable(self, metastore_id: str, schema_name: str):
|
|
14230
|
-
"""
|
|
14231
|
-
|
|
14232
|
-
Disables the system schema and removes it from the system catalog. The caller must be an account admin
|
|
14071
|
+
"""Disables the system schema and removes it from the system catalog. The caller must be an account admin
|
|
14233
14072
|
or a metastore admin.
|
|
14234
14073
|
|
|
14235
14074
|
:param metastore_id: str
|
|
@@ -14249,9 +14088,7 @@ class SystemSchemasAPI:
|
|
|
14249
14088
|
)
|
|
14250
14089
|
|
|
14251
14090
|
def enable(self, metastore_id: str, schema_name: str, *, catalog_name: Optional[str] = None):
|
|
14252
|
-
"""
|
|
14253
|
-
|
|
14254
|
-
Enables the system schema and adds it to the system catalog. The caller must be an account admin or a
|
|
14091
|
+
"""Enables the system schema and adds it to the system catalog. The caller must be an account admin or a
|
|
14255
14092
|
metastore admin.
|
|
14256
14093
|
|
|
14257
14094
|
:param metastore_id: str
|
|
@@ -14281,9 +14118,7 @@ class SystemSchemasAPI:
|
|
|
14281
14118
|
def list(
|
|
14282
14119
|
self, metastore_id: str, *, max_results: Optional[int] = None, page_token: Optional[str] = None
|
|
14283
14120
|
) -> Iterator[SystemSchemaInfo]:
|
|
14284
|
-
"""
|
|
14285
|
-
|
|
14286
|
-
Gets an array of system schemas for a metastore. The caller must be an account admin or a metastore
|
|
14121
|
+
"""Gets an array of system schemas for a metastore. The caller must be an account admin or a metastore
|
|
14287
14122
|
admin.
|
|
14288
14123
|
|
|
14289
14124
|
:param metastore_id: str
|
|
@@ -14336,9 +14171,7 @@ class TableConstraintsAPI:
|
|
|
14336
14171
|
self._api = api_client
|
|
14337
14172
|
|
|
14338
14173
|
def create(self, full_name_arg: str, constraint: TableConstraint) -> TableConstraint:
|
|
14339
|
-
"""
|
|
14340
|
-
|
|
14341
|
-
Creates a new table constraint.
|
|
14174
|
+
"""Creates a new table constraint.
|
|
14342
14175
|
|
|
14343
14176
|
For the table constraint creation to succeed, the user must satisfy both of these conditions: - the
|
|
14344
14177
|
user must have the **USE_CATALOG** privilege on the table's parent catalog, the **USE_SCHEMA**
|
|
@@ -14369,9 +14202,7 @@ class TableConstraintsAPI:
|
|
|
14369
14202
|
return TableConstraint.from_dict(res)
|
|
14370
14203
|
|
|
14371
14204
|
def delete(self, full_name: str, constraint_name: str, cascade: bool):
|
|
14372
|
-
"""
|
|
14373
|
-
|
|
14374
|
-
Deletes a table constraint.
|
|
14205
|
+
"""Deletes a table constraint.
|
|
14375
14206
|
|
|
14376
14207
|
For the table constraint deletion to succeed, the user must satisfy both of these conditions: - the
|
|
14377
14208
|
user must have the **USE_CATALOG** privilege on the table's parent catalog, the **USE_SCHEMA**
|
|
@@ -14417,9 +14248,7 @@ class TablesAPI:
|
|
|
14417
14248
|
self._api = api_client
|
|
14418
14249
|
|
|
14419
14250
|
def delete(self, full_name: str):
|
|
14420
|
-
"""
|
|
14421
|
-
|
|
14422
|
-
Deletes a table from the specified parent catalog and schema. The caller must be the owner of the
|
|
14251
|
+
"""Deletes a table from the specified parent catalog and schema. The caller must be the owner of the
|
|
14423
14252
|
parent catalog, have the **USE_CATALOG** privilege on the parent catalog and be the owner of the
|
|
14424
14253
|
parent schema, or be the owner of the table and have the **USE_CATALOG** privilege on the parent
|
|
14425
14254
|
catalog and the **USE_SCHEMA** privilege on the parent schema.
|
|
@@ -14437,9 +14266,7 @@ class TablesAPI:
|
|
|
14437
14266
|
self._api.do("DELETE", f"/api/2.1/unity-catalog/tables/{full_name}", headers=headers)
|
|
14438
14267
|
|
|
14439
14268
|
def exists(self, full_name: str) -> TableExistsResponse:
|
|
14440
|
-
"""
|
|
14441
|
-
|
|
14442
|
-
Gets if a table exists in the metastore for a specific catalog and schema. The caller must satisfy one
|
|
14269
|
+
"""Gets if a table exists in the metastore for a specific catalog and schema. The caller must satisfy one
|
|
14443
14270
|
of the following requirements: * Be a metastore admin * Be the owner of the parent catalog * Be the
|
|
14444
14271
|
owner of the parent schema and have the USE_CATALOG privilege on the parent catalog * Have the
|
|
14445
14272
|
**USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema,
|
|
@@ -14467,9 +14294,7 @@ class TablesAPI:
|
|
|
14467
14294
|
include_delta_metadata: Optional[bool] = None,
|
|
14468
14295
|
include_manifest_capabilities: Optional[bool] = None,
|
|
14469
14296
|
) -> TableInfo:
|
|
14470
|
-
"""
|
|
14471
|
-
|
|
14472
|
-
Gets a table from the metastore for a specific catalog and schema. The caller must satisfy one of the
|
|
14297
|
+
"""Gets a table from the metastore for a specific catalog and schema. The caller must satisfy one of the
|
|
14473
14298
|
following requirements: * Be a metastore admin * Be the owner of the parent catalog * Be the owner of
|
|
14474
14299
|
the parent schema and have the USE_CATALOG privilege on the parent catalog * Have the **USE_CATALOG**
|
|
14475
14300
|
privilege on the parent catalog and the **USE_SCHEMA** privilege on the parent schema, and either be
|
|
@@ -14516,9 +14341,7 @@ class TablesAPI:
|
|
|
14516
14341
|
omit_username: Optional[bool] = None,
|
|
14517
14342
|
page_token: Optional[str] = None,
|
|
14518
14343
|
) -> Iterator[TableInfo]:
|
|
14519
|
-
"""
|
|
14520
|
-
|
|
14521
|
-
Gets an array of all tables for the current metastore under the parent catalog and schema. The caller
|
|
14344
|
+
"""Gets an array of all tables for the current metastore under the parent catalog and schema. The caller
|
|
14522
14345
|
must be a metastore admin or an owner of (or have the **SELECT** privilege on) the table. For the
|
|
14523
14346
|
latter case, the caller must also be the owner or have the **USE_CATALOG** privilege on the parent
|
|
14524
14347
|
catalog and the **USE_SCHEMA** privilege on the parent schema. There is no guarantee of a specific
|
|
@@ -14599,9 +14422,7 @@ class TablesAPI:
|
|
|
14599
14422
|
schema_name_pattern: Optional[str] = None,
|
|
14600
14423
|
table_name_pattern: Optional[str] = None,
|
|
14601
14424
|
) -> Iterator[TableSummary]:
|
|
14602
|
-
"""
|
|
14603
|
-
|
|
14604
|
-
Gets an array of summaries for tables for a schema and catalog within the metastore. The table
|
|
14425
|
+
"""Gets an array of summaries for tables for a schema and catalog within the metastore. The table
|
|
14605
14426
|
summaries returned are either:
|
|
14606
14427
|
|
|
14607
14428
|
* summaries for tables (within the current metastore and parent catalog and schema), when the user is
|
|
@@ -14661,9 +14482,7 @@ class TablesAPI:
|
|
|
14661
14482
|
query["page_token"] = json["next_page_token"]
|
|
14662
14483
|
|
|
14663
14484
|
def update(self, full_name: str, *, owner: Optional[str] = None):
|
|
14664
|
-
"""
|
|
14665
|
-
|
|
14666
|
-
Change the owner of the table. The caller must be the owner of the parent catalog, have the
|
|
14485
|
+
"""Change the owner of the table. The caller must be the owner of the parent catalog, have the
|
|
14667
14486
|
**USE_CATALOG** privilege on the parent catalog and be the owner of the parent schema, or be the owner
|
|
14668
14487
|
of the table and have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA**
|
|
14669
14488
|
privilege on the parent schema.
|
|
@@ -14705,9 +14524,7 @@ class TemporaryTableCredentialsAPI:
|
|
|
14705
14524
|
def generate_temporary_table_credentials(
|
|
14706
14525
|
self, *, operation: Optional[TableOperation] = None, table_id: Optional[str] = None
|
|
14707
14526
|
) -> GenerateTemporaryTableCredentialResponse:
|
|
14708
|
-
"""
|
|
14709
|
-
|
|
14710
|
-
Get a short-lived credential for directly accessing the table data on cloud storage. The metastore
|
|
14527
|
+
"""Get a short-lived credential for directly accessing the table data on cloud storage. The metastore
|
|
14711
14528
|
must have external_access_enabled flag set to true (default false). The caller must have
|
|
14712
14529
|
EXTERNAL_USE_SCHEMA privilege on the parent schema and this privilege can only be granted by catalog
|
|
14713
14530
|
owners.
|
|
@@ -14755,9 +14572,7 @@ class VolumesAPI:
|
|
|
14755
14572
|
comment: Optional[str] = None,
|
|
14756
14573
|
storage_location: Optional[str] = None,
|
|
14757
14574
|
) -> VolumeInfo:
|
|
14758
|
-
"""
|
|
14759
|
-
|
|
14760
|
-
Creates a new volume.
|
|
14575
|
+
"""Creates a new volume.
|
|
14761
14576
|
|
|
14762
14577
|
The user could create either an external volume or a managed volume. An external volume will be
|
|
14763
14578
|
created in the specified external location, while a managed volume will be located in the default
|
|
@@ -14814,9 +14629,7 @@ class VolumesAPI:
|
|
|
14814
14629
|
return VolumeInfo.from_dict(res)
|
|
14815
14630
|
|
|
14816
14631
|
def delete(self, name: str):
|
|
14817
|
-
"""
|
|
14818
|
-
|
|
14819
|
-
Deletes a volume from the specified parent catalog and schema.
|
|
14632
|
+
"""Deletes a volume from the specified parent catalog and schema.
|
|
14820
14633
|
|
|
14821
14634
|
The caller must be a metastore admin or an owner of the volume. For the latter case, the caller must
|
|
14822
14635
|
also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA**
|
|
@@ -14841,9 +14654,7 @@ class VolumesAPI:
|
|
|
14841
14654
|
max_results: Optional[int] = None,
|
|
14842
14655
|
page_token: Optional[str] = None,
|
|
14843
14656
|
) -> Iterator[VolumeInfo]:
|
|
14844
|
-
"""
|
|
14845
|
-
|
|
14846
|
-
Gets an array of volumes for the current metastore under the parent catalog and schema.
|
|
14657
|
+
"""Gets an array of volumes for the current metastore under the parent catalog and schema.
|
|
14847
14658
|
|
|
14848
14659
|
The returned volumes are filtered based on the privileges of the calling user. For example, the
|
|
14849
14660
|
metastore admin is able to list all the volumes. A regular user needs to be the owner or have the
|
|
@@ -14904,9 +14715,7 @@ class VolumesAPI:
|
|
|
14904
14715
|
query["page_token"] = json["next_page_token"]
|
|
14905
14716
|
|
|
14906
14717
|
def read(self, name: str, *, include_browse: Optional[bool] = None) -> VolumeInfo:
|
|
14907
|
-
"""
|
|
14908
|
-
|
|
14909
|
-
Gets a volume from the metastore for a specific catalog and schema.
|
|
14718
|
+
"""Gets a volume from the metastore for a specific catalog and schema.
|
|
14910
14719
|
|
|
14911
14720
|
The caller must be a metastore admin or an owner of (or have the **READ VOLUME** privilege on) the
|
|
14912
14721
|
volume. For the latter case, the caller must also be the owner or have the **USE_CATALOG** privilege
|
|
@@ -14934,9 +14743,7 @@ class VolumesAPI:
|
|
|
14934
14743
|
def update(
|
|
14935
14744
|
self, name: str, *, comment: Optional[str] = None, new_name: Optional[str] = None, owner: Optional[str] = None
|
|
14936
14745
|
) -> VolumeInfo:
|
|
14937
|
-
"""
|
|
14938
|
-
|
|
14939
|
-
Updates the specified volume under the specified parent catalog and schema.
|
|
14746
|
+
"""Updates the specified volume under the specified parent catalog and schema.
|
|
14940
14747
|
|
|
14941
14748
|
The caller must be a metastore admin or an owner of the volume. For the latter case, the caller must
|
|
14942
14749
|
also be the owner or have the **USE_CATALOG** privilege on the parent catalog and the **USE_SCHEMA**
|
|
@@ -14991,9 +14798,7 @@ class WorkspaceBindingsAPI:
|
|
|
14991
14798
|
self._api = api_client
|
|
14992
14799
|
|
|
14993
14800
|
def get(self, name: str) -> GetCatalogWorkspaceBindingsResponse:
|
|
14994
|
-
"""
|
|
14995
|
-
|
|
14996
|
-
Gets workspace bindings of the catalog. The caller must be a metastore admin or an owner of the
|
|
14801
|
+
"""Gets workspace bindings of the catalog. The caller must be a metastore admin or an owner of the
|
|
14997
14802
|
catalog.
|
|
14998
14803
|
|
|
14999
14804
|
:param name: str
|
|
@@ -15017,9 +14822,7 @@ class WorkspaceBindingsAPI:
|
|
|
15017
14822
|
max_results: Optional[int] = None,
|
|
15018
14823
|
page_token: Optional[str] = None,
|
|
15019
14824
|
) -> Iterator[WorkspaceBinding]:
|
|
15020
|
-
"""
|
|
15021
|
-
|
|
15022
|
-
Gets workspace bindings of the securable. The caller must be a metastore admin or an owner of the
|
|
14825
|
+
"""Gets workspace bindings of the securable. The caller must be a metastore admin or an owner of the
|
|
15023
14826
|
securable.
|
|
15024
14827
|
|
|
15025
14828
|
:param securable_type: str
|
|
@@ -15068,9 +14871,7 @@ class WorkspaceBindingsAPI:
|
|
|
15068
14871
|
assign_workspaces: Optional[List[int]] = None,
|
|
15069
14872
|
unassign_workspaces: Optional[List[int]] = None,
|
|
15070
14873
|
) -> UpdateCatalogWorkspaceBindingsResponse:
|
|
15071
|
-
"""
|
|
15072
|
-
|
|
15073
|
-
Updates workspace bindings of the catalog. The caller must be a metastore admin or an owner of the
|
|
14874
|
+
"""Updates workspace bindings of the catalog. The caller must be a metastore admin or an owner of the
|
|
15074
14875
|
catalog.
|
|
15075
14876
|
|
|
15076
14877
|
:param name: str
|
|
@@ -15105,9 +14906,7 @@ class WorkspaceBindingsAPI:
|
|
|
15105
14906
|
add: Optional[List[WorkspaceBinding]] = None,
|
|
15106
14907
|
remove: Optional[List[WorkspaceBinding]] = None,
|
|
15107
14908
|
) -> UpdateWorkspaceBindingsResponse:
|
|
15108
|
-
"""
|
|
15109
|
-
|
|
15110
|
-
Updates workspace bindings of the securable. The caller must be a metastore admin or an owner of the
|
|
14909
|
+
"""Updates workspace bindings of the securable. The caller must be a metastore admin or an owner of the
|
|
15111
14910
|
securable.
|
|
15112
14911
|
|
|
15113
14912
|
:param securable_type: str
|