decorative_secrets.databricks
DatabricksWorkspaceClientArguments
dataclass
An object holding arguments to pass to a Databricks workspace client if/when retrieving secrets remotely.
Source code in src/decorative_secrets/databricks.py
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 | |
apply_databricks_secrets_arguments
apply_databricks_secrets_arguments(
*args: decorative_secrets.databricks.DatabricksWorkspaceClientArguments,
**kwargs: str
) -> collections.abc.Callable
This decorator maps parameter names to Databricks secrets.
Each key in databricks_secret_arguments represents the name of a
parameter in the decorated function which accepts an explicit input, and
the corresponding mapped value is a parameter name accepting a tuple with
the secret scope and key with which to lookup a secret to pass to the
mapped parameter in lieu of an explicitly provided argument.
Parameters:
-
*args(decorative_secrets.databricks.DatabricksWorkspaceClientArguments, default:()) –A
DatabricksWorkspaceConfigArgumentsinstance to configure a workspace client when retrieving secrets remotely (if more than one is provided, only the first is used). -
**kwargs(str, default:{}) –A mapping of static parameter names to the parameter names of arguments accepting Databricks secret scope + key tuples from which to retrieve a value when the key argument is not explicitly provided.
Example
from functools import (
cache,
)
from decorative_secrets.databricks import (
apply_databricks_secret_arguments,
)
from my_client_sdk import (
Client,
)
@cache
@apply_databricks_secret_arguments(
client_id="client_id_databricks_secret",
client_secret="client_secret_databricks_secret",
)
def get_client(
client_id: str | None = None,
client_secret: str = None,
client_id_databricks_secret: str | None = None,
client_secret_databricks_secret: str | None = None,
) -> Client:
return Client(
oauth2_client_id=client_id,
oauth2_client_secret=client_secret,
)
client: Client = get_client(
client_id_databricks_secret=(
"client",
"client-id",
),
client_secret_databricks_secret=(
"client",
"client-secret",
),
)
Source code in src/decorative_secrets/databricks.py
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | |
which_databricks
which_databricks(*, timeout: float | None = 60) -> str
Find the databricks executable, or install the Databricks CLI if not
found.
Source code in src/decorative_secrets/databricks.py
269 270 271 272 273 274 275 276 277 278 279 280 | |
databricks_auth_login
databricks_auth_login(
host: str | None = None,
profile: str | None = None,
target: str | None = None,
*,
force: bool = False,
timeout: float | None = 60
) -> None
Log in to Databricks using the CLI if not already logged in.
Parameters:
-
host(str | None, default:None) –A Databricks workspace host URL.
-
profile(str | None, default:None) –A Databricks Configuration Profile.
-
target(str | None, default:None) –A Databricks CLI target.
-
force(bool, default:False) –Whether to force login even if already authenticated.
-
timeout(float | None, default:60) –A timeout in seconds for the login operation.
Raises:
-
subprocess.CalledProcessError–If the Databricks CLI command returns a non-zero exit code
-
FileNotFoundError–If the Databricks CLI is not found.
-
decorative_secrets.errors.DatabricksCLINotInstalledError–If the Databricks CLI cannot be installed.
-
TimeoutExpired–If the command takes longer than
timeoutseconds to complete
Source code in src/decorative_secrets/databricks.py
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 | |
get_databricks_workspace_client
get_databricks_workspace_client(
host: str | None = None,
account_id: str | None = None,
username: str | None = None,
password: str | None = None,
client_id: str | None = None,
client_secret: str | None = None,
token: str | None = None,
profile: str | None = None,
config_file: str | None = None,
azure_workspace_resource_id: str | None = None,
azure_client_secret: str | None = None,
azure_client_id: str | None = None,
azure_tenant_id: str | None = None,
azure_environment: str | None = None,
auth_type: str | None = None,
cluster_id: str | None = None,
google_credentials: str | None = None,
google_service_account: str | None = None,
debug_truncate_bytes: int | None = None,
*,
debug_headers: bool | None = None,
product: str | None = None,
product_version: str | None = None,
credentials_strategy: (
databricks.sdk.credentials_provider.CredentialsStrategy
| None
) = None,
credentials_provider: (
databricks.sdk.credentials_provider.CredentialsStrategy
| None
) = None,
token_audience: str | None = None,
config: databricks.sdk.config.Config | None = None,
timeout: float | None = 60
) -> databricks.sdk.WorkspaceClient
Get a Databricks WorkspaceClient configured from environment variables.
Source code in src/decorative_secrets/databricks.py
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 | |
get_dbutils
get_dbutils(
host: str | None = None,
account_id: str | None = None,
username: str | None = None,
password: str | None = None,
client_id: str | None = None,
client_secret: str | None = None,
token: str | None = None,
profile: str | None = None,
config_file: str | None = None,
azure_workspace_resource_id: str | None = None,
azure_client_secret: str | None = None,
azure_client_id: str | None = None,
azure_tenant_id: str | None = None,
azure_environment: str | None = None,
auth_type: str | None = None,
cluster_id: str | None = None,
google_credentials: str | None = None,
google_service_account: str | None = None,
debug_truncate_bytes: int | None = None,
*,
debug_headers: bool | None = None,
product: str = "unknown",
product_version: str = "0.0.0",
credentials_strategy: (
databricks.sdk.credentials_provider.CredentialsStrategy
| None
) = None,
credentials_provider: (
databricks.sdk.credentials_provider.CredentialsStrategy
| None
) = None,
token_audience: str | None = None,
config: databricks.sdk.config.Config | None = None,
timeout: float | None = 60
) -> databricks.sdk.dbutils.RemoteDbUtils
Get dbutils using an existing instance from the runtime if found, otherwise, creating one using a workspace client (this requires either having these environment variables set , or providing the equivalent optional arguments.
Source code in src/decorative_secrets/databricks.py
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 | |
get_databricks_secret
get_databricks_secret(
scope: str,
key: str,
host: str | None = None,
account_id: str | None = None,
username: str | None = None,
password: str | None = None,
client_id: str | None = None,
client_secret: str | None = None,
token: str | None = None,
profile: str | None = None,
config_file: str | None = None,
azure_workspace_resource_id: str | None = None,
azure_client_secret: str | None = None,
azure_client_id: str | None = None,
azure_tenant_id: str | None = None,
azure_environment: str | None = None,
auth_type: str | None = None,
cluster_id: str | None = None,
google_credentials: str | None = None,
google_service_account: str | None = None,
debug_truncate_bytes: int | None = None,
*,
debug_headers: bool | None = None,
product: str = "unknown",
product_version: str = "0.0.0",
credentials_strategy: (
databricks.sdk.credentials_provider.CredentialsStrategy
| None
) = None,
credentials_provider: (
databricks.sdk.credentials_provider.CredentialsStrategy
| None
) = None,
token_audience: str | None = None,
config: databricks.sdk.config.Config | None = None,
timeout: float | None = 60
) -> str
Get a secret from Databricks.
Parameters:
-
scope(str) –The Databricks secret scope.
-
key(str) –The Databricks secret key.
-
host(str | None, default:None) –A Databricks workspace host URL.
-
account_id(str | None, default:None) –A Databricks account ID.
-
username(str | None, default:None) –A Databricks username.
-
password(str | None, default:None) –A Databricks password.
-
client_id(str | None, default:None) –A Databricks OAuth2 Client ID.
-
client_secret(str | None, default:None) –A Databricks OAuth2 Client Secret.
-
token(str | None, default:None) –A Databricks Personal Access Token.
-
profile(str | None, default:None) –A Databricks Configuration Profile.
-
config_file(str | None, default:None) –A Databricks Configuration File path.
-
azure_workspace_resource_id(str | None, default:None) –An Azure Databricks Workspace Resource ID.
-
azure_client_secret(str | None, default:None) –An Azure Client Secret for Azure Databricks auth.
-
azure_client_id(str | None, default:None) –An Azure Client ID for Azure Databricks auth.
-
azure_tenant_id(str | None, default:None) –An Azure Tenant ID for Azure Databricks auth.
-
azure_environment(str | None, default:None) –An Azure Environment for Azure Databricks auth.
-
auth_type(str | None, default:None) –A Databricks authentication type.
-
cluster_id(str | None, default:None) –A Databricks cluster ID.
-
google_credentials(str | None, default:None) –Google Cloud credentials for GCP Databricks auth.
-
google_service_account(str | None, default:None) –A Google Service Account for GCP Databricks auth.
-
debug_truncate_bytes(int | None, default:None) –Number of bytes to truncate in debug logs.
-
debug_headers(bool | None, default:None) –Whether to enable debug logging of HTTP headers.
-
product(str, default:'unknown') –The product name using the SDK.
-
product_version(str, default:'0.0.0') –The product version using the SDK.
-
credentials_strategy(databricks.sdk.credentials_provider.CredentialsStrategy | None, default:None) –A credentials strategy for the SDK.
-
credentials_provider(databricks.sdk.credentials_provider.CredentialsStrategy | None, default:None) –A credentials provider for the SDK.
-
token_audience(str | None, default:None) –A token audience for the SDK.
-
config(databricks.sdk.config.Config | None, default:None) –A Databricks SDK Config instance.
-
timeout(float | None, default:60) –A timeout in seconds for any underlying Databricks CLI invocation (e.g. an implicit
databricks auth login).
Source code in src/decorative_secrets/databricks.py
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 | |
main
main() -> None
Run a command: - install: Install the Databricks CLI if not already installed - get: Get a secret from Databricks and print it to stdout
Source code in src/decorative_secrets/databricks.py
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 | |