databricks-sdk-py
Databricks SDK for Python (Beta)
File Explorer
Download Latest Version (.zip)- write-pr-description.md
- _last_sha
- _openapi_sha
- action.yml
- feature_request.md
- sdk-issue.md
- external-message.yml
- integration-tests.yml
- push.yml
- sync-label.yml
- tagging.yml
- test.yml
- dependabot.yml
- PULL_REQUEST_TEMPLATE.md
- __init__.py
- default_widgets_utils.py
- ipywidgets_utils.py
- __init__.py
- fieldmask.py
- lro.py
- __init__.py
- base.py
- customizer.py
- deserializer.py
- details.py
- mapper.py
- overrides.py
- parser.py
- platform.py
- private_link.py
- sdk.py
- __init__.py
- round_trip_logger.py
- __init__.py
- compute.py
- files.py
- files_utils.py
- jobs.py
- open_ai_client.py
- sharing.py
- workspace.py
- __init__.py
- dbutils_stub.py
- __init__.py
- _internal.py
- agentbricks.py
- aisearch.py
- apps.py
- billing.py
- bundle.py
- bundledeployments.py
- catalog.py
- cleanrooms.py
- compute.py
- dashboards.py
- database.py
- dataclassification.py
- dataquality.py
- disasterrecovery.py
- environments.py
- files.py
- iam.py
- iamv2.py
- jobs.py
- knowledgeassistants.py
- marketplace.py
- ml.py
- networking.py
- oauth2.py
- pipelines.py
- postgres.py
- provisioning.py
- qualitymonitorv2.py
- serving.py
- settings.py
- settingsv2.py
- sharing.py
- sql.py
- supervisoragents.py
- tags.py
- vectorsearch.py
- workspace.py
- __init__.py
- _base_client.py
- _property.py
- azure.py
- casing.py
- client_types.py
- clock.py
- config.py
- core.py
- credentials_provider.py
- data_plane.py
- dbutils.py
- environments.py
- oauth.py
- oidc.py
- oidc_token_supplier.py
- py.typed
- retries.py
- useragent.py
- version.py
- __init__.py
- billable_usage.rst
- budget_policy.rst
- budgets.rst
- index.rst
- log_delivery.rst
- usage_dashboards.rst
- usage_policy.rst
- index.rst
- metastore_assignments.rst
- metastores.rst
- storage_credentials.rst
- disaster_recovery.rst
- index.rst
- access_control.rst
- groups_v2.rst
- index.rst
- service_principals_v2.rst
- users_v2.rst
- workspace_assignment.rst
- iam_v2.rst
- index.rst
- endpoints.rst
- index.rst
- custom_app_integration.rst
- federation_policy.rst
- index.rst
- o_auth_published_apps.rst
- published_app_integration.rst
- service_principal_federation_policy.rst
- service_principal_secrets.rst
- credentials.rst
- encryption_keys.rst
- index.rst
- networks.rst
- private_access.rst
- storage.rst
- vpc_endpoints.rst
- workspaces.rst
- csp_enablement_account.rst
- disable_legacy_features.rst
- enable_ip_access_lists.rst
- esm_enablement_account.rst
- index.rst
- ip_access_lists.rst
- llm_proxy_partner_powered_account.rst
- llm_proxy_partner_powered_enforce.rst
- network_connectivity.rst
- network_policies.rst
- personal_compute.rst
- settings.rst
- workspace_network_configuration.rst
- index.rst
- settings_v2.rst
- index.rst
- account.rst
- workspace.rst
- agentbricks.rst
- aisearch.rst
- apps.rst
- billing.rst
- bundledeployments.rst
- catalog.rst
- cleanrooms.rst
- compute.rst
- dashboards.rst
- database.rst
- dataclassification.rst
- dataquality.rst
- disasterrecovery.rst
- environments.rst
- files.rst
- iam.rst
- iamv2.rst
- index.rst
- jobs.rst
- knowledgeassistants.rst
- marketplace.rst
- ml.rst
- networking.rst
- oauth2.rst
- pipelines.rst
- postgres.rst
- provisioning.rst
- qualitymonitorv2.rst
- serving.rst
- settings.rst
- settingsv2.rst
- sharing.rst
- sql.rst
- supervisoragents.rst
- tags.rst
- vectorsearch.rst
- workspace.rst
- aad-approve-app.png
- databricks-logo.svg
- external-browser-finish.png
- flask-oauth.gif
- notebook-native-auth.gif
- agent_bricks.rst
- index.rst
- ai_search.rst
- index.rst
- apps.rst
- apps_settings.rst
- index.rst
- bundle_deployments.rst
- index.rst
- ai_gateway.rst
- artifact_allowlists.rst
- catalogs.rst
- connections.rst
- credentials.rst
- entity_tag_assignments.rst
- external_lineage.rst
- external_locations.rst
- external_metadata.rst
- functions.rst
- grants.rst
- index.rst
- metastores.rst
- model_versions.rst
- online_tables.rst
- policies.rst
- quality_monitors.rst
- registered_models.rst
- resource_quotas.rst
- rfa.rst
- schemas.rst
- secrets_uc.rst
- storage_credentials.rst
- system_schemas.rst
- table_constraints.rst
- tables.rst
- temporary_path_credentials.rst
- temporary_table_credentials.rst
- temporary_volume_credentials.rst
- volumes.rst
- workspace_bindings.rst
- clean_room_asset_revisions.rst
- clean_room_assets.rst
- clean_room_auto_approval_rules.rst
- clean_room_task_runs.rst
- clean_rooms.rst
- index.rst
- cluster_policies.rst
- clusters.rst
- command_execution.rst
- global_init_scripts.rst
- index.rst
- instance_pools.rst
- instance_profiles.rst
- libraries.rst
- policy_compliance_for_clusters.rst
- policy_families.rst
- genie.rst
- index.rst
- lakeview.rst
- lakeview_embedded.rst
- database.rst
- index.rst
- data_classification.rst
- index.rst
- data_quality.rst
- index.rst
- environments.rst
- index.rst
- dbfs.rst
- files.rst
- index.rst
- access_control.rst
- account_access_control_proxy.rst
- current_user.rst
- groups_v2.rst
- index.rst
- permission_migration.rst
- permissions.rst
- service_principals_v2.rst
- users_v2.rst
- index.rst
- workspace_iam_v2.rst
- index.rst
- jobs.rst
- policy_compliance_for_jobs.rst
- index.rst
- knowledge_assistants.rst
- consumer_fulfillments.rst
- consumer_installations.rst
- consumer_listings.rst
- consumer_personalization_requests.rst
- consumer_providers.rst
- index.rst
- provider_exchange_filters.rst
- provider_exchanges.rst
- provider_files.rst
- provider_listings.rst
- provider_personalization_requests.rst
- provider_provider_analytics_dashboards.rst
- provider_providers.rst
- experiments.rst
- feature_engineering.rst
- feature_store.rst
- forecasting.rst
- index.rst
- materialized_features.rst
- model_registry.rst
- index.rst
- service_principal_secrets_proxy.rst
- index.rst
- pipelines.rst
- index.rst
- postgres.rst
- index.rst
- quality_monitor_v2.rst
- index.rst
- serving_endpoints.rst
- serving_endpoints_data_plane.rst
- aibi_dashboard_embedding_access_policy.rst
- aibi_dashboard_embedding_approved_domains.rst
- automatic_cluster_update.rst
- compliance_security_profile.rst
- credentials_manager.rst
- dashboard_email_subscriptions.rst
- default_namespace.rst
- default_warehouse_id.rst
- disable_legacy_access.rst
- disable_legacy_dbfs.rst
- enable_export_notebook.rst
- enable_notebook_table_clipboard.rst
- enable_results_downloading.rst
- enhanced_security_monitoring.rst
- index.rst
- ip_access_lists.rst
- llm_proxy_partner_powered_workspace.rst
- notification_destinations.rst
- restrict_workspace_admins.rst
- settings.rst
- sql_results_download.rst
- token_management.rst
- tokens.rst
- workspace_conf.rst
- index.rst
- workspace_settings_v2.rst
- index.rst
- providers.rst
- recipient_activation.rst
- recipient_federation_policies.rst
- recipients.rst
- shares.rst
- alerts.rst
- alerts_legacy.rst
- alerts_v2.rst
- dashboard_widgets.rst
- dashboards.rst
- data_sources.rst
- dbsql_permissions.rst
- index.rst
- queries.rst
- queries_legacy.rst
- query_history.rst
- query_visualizations.rst
- query_visualizations_legacy.rst
- redash_config.rst
- statement_execution.rst
- warehouses.rst
- index.rst
- supervisor_agents.rst
- index.rst
- tag_policies.rst
- workspace_entity_tag_assignments.rst
- index.rst
- vector_search_endpoints.rst
- vector_search_indexes.rst
- git_credentials.rst
- index.rst
- repos.rst
- secrets.rst
- workspace.rst
- index.rst
- .gitignore
- auth-types-reference.md
- authentication.md
- conf.py
- dataplane.md
- db_sphinx_ext.py
- dbutils.md
- gen-client-docs.py
- getting-started.md
- index.rst
- logging.md
- Makefile
- oauth.md
- packages.py
- pagination.md
- wait.md
- download_usage_download.py
- create_budgets.py
- get_budgets.py
- list_budgets.py
- update_budgets.py
- create_credentials.py
- create_log_delivery.py
- create_workspaces.py
- get_credentials.py
- list_credentials.py
- create_encryption_keys.py
- get_encryption_keys.py
- list_encryption_keys.py
- read_usage_download.py
- create_log_delivery.py
- get_log_delivery.py
- list_log_delivery.py
- list_metastore_assignments.py
- create_networks.py
- get_networks.py
- list_networks.py
- create_private_access.py
- get_private_access.py
- list_private_access.py
- replace_private_access.py
- create_account_service_principal.py
- create_workspace_assignment.py
- create_workspace_assignment_on_aws.py
- get_account_service_principal.py
- list_account_service_principal.py
- patch_account_service_principal.py
- update_account_service_principal.py
- create_log_delivery.py
- create_storage.py
- create_workspaces.py
- get_storage.py
- list_storage.py
- create_account_users.py
- delete_account_users.py
- get_account_users.py
- patch_account_users.py
- create_vpc_endpoints.py
- get_vpc_endpoints.py
- list_vpc_endpoints.py
- get_workspaces.py
- list_workspace_assignment.py
- list_workspace_assignment_on_aws.py
- update_workspace_assignment.py
- update_workspace_assignment_on_aws.py
- create_workspaces.py
- get_workspaces.py
- list_workspaces.py
- update_workspaces.py
- create_alerts.py
- get_alerts.py
- list_alerts.py
- update_alerts.py
- create_catalog_workspace_bindings.py
- create_catalogs.py
- create_schemas.py
- create_shares.py
- create_tables.py
- create_volumes.py
- get_catalogs.py
- list_catalogs.py
- update_catalog_workspace_bindings.py
- update_catalogs.py
- create_cluster_policies.py
- edit_cluster_policies.py
- get_cluster_policies.py
- list_cluster_policies.py
- change_owner_clusters_api_integration.py
- create_clusters_api_integration.py
- delete_clusters_api_integration.py
- edit_clusters_api_integration.py
- ensure_cluster_is_running_commands_direct_usage.py
- events_clusters_api_integration.py
- get_clusters_api_integration.py
- list_clusters_api_integration.py
- list_node_types_clusters_api_integration.py
- pin_clusters_api_integration.py
- resize_clusters_api_integration.py
- restart_clusters_api_integration.py
- select_node_type_instance_pools.py
- select_spark_version_clusters_api_integration.py
- start_clusters_api_integration.py
- unpin_clusters_api_integration.py
- execute_commands.py
- create_commands_direct_usage.py
- execute_commands_direct_usage.py
- start_commands.py
- execute_commands.py
- create_connections.py
- get_connections.py
- list_connections.py
- update_connections.py
- me_current_user.py
- me_tokens.py
- create_dashboards.py
- delete_dashboards.py
- get_dashboards.py
- list_dashboards.py
- restore_dashboards.py
- list_alerts.py
- list_queries.py
- must_tokens.py
- download_file.py
- create_experiment_experiments.py
- create_experiment_m_lflow_runs.py
- create_run_m_lflow_runs.py
- get_experiment_experiments.py
- list_experiments_experiments.py
- update_experiment_experiments.py
- update_run_m_lflow_runs.py
- create_external_locations.py
- create_external_locations_on_aws.py
- create_volumes.py
- get_external_locations.py
- get_external_locations_on_aws.py
- list_external_locations.py
- list_external_locations_on_aws.py
- update_external_locations.py
- update_external_locations_on_aws.py
- create_git_credentials.py
- get_git_credentials.py
- list_git_credentials.py
- update_git_credentials.py
- create_global_init_scripts.py
- get_global_init_scripts.py
- list_global_init_scripts.py
- update_global_init_scripts.py
- get_effective_tables.py
- update_tables.py
- create_generic_permissions.py
- create_groups.py
- create_secrets.py
- delete_generic_permissions.py
- delete_groups.py
- delete_secrets.py
- get_groups.py
- patch_groups.py
- create_instance_pools.py
- edit_instance_pools.py
- get_instance_pools.py
- list_instance_pools.py
- add_aws_instance_profiles.py
- edit_aws_instance_profiles.py
- list_aws_instance_profiles.py
- create_ip_access_lists.py
- get_ip_access_lists.py
- list_ip_access_lists.py
- replace_ip_access_lists.py
- cancel_all_runs_jobs_api_full_integration.py
- cancel_run_jobs_api_full_integration.py
- create_jobs_api_full_integration.py
- export_run_jobs_api_full_integration.py
- get_jobs_api_full_integration.py
- get_run_output_jobs_api_full_integration.py
- list_jobs_api_full_integration.py
- list_runs_jobs_api_full_integration.py
- repair_run_jobs_api_full_integration.py
- reset_jobs_api_full_integration.py
- run_now_jobs_api_full_integration.py
- submit_jobs_api_full_integration.py
- update_jobs_api_full_integration.py
- update_libraries.py
- assign_metastores.py
- create_metastores.py
- current_metastores.py
- enable_optimization_metastores.py
- get_metastores.py
- list_metastores.py
- maintenance_metastores.py
- summary_metastores.py
- unassign_metastores.py
- update_metastores.py
- create_comment_model_version_comments.py
- create_model_model_version_comments.py
- create_model_model_versions.py
- create_model_models.py
- create_model_version_model_version_comments.py
- create_model_version_model_versions.py
- create_webhook_registry_webhooks.py
- get_model_models.py
- list_models_models.py
- list_webhooks_registry_webhooks.py
- update_comment_model_version_comments.py
- update_model_models.py
- update_model_version_model_versions.py
- update_webhook_registry_webhooks.py
- get_generic_permissions.py
- get_permission_levels_generic_permissions.py
- set_generic_permissions.py
- create_pipelines.py
- get_pipelines.py
- list_pipeline_events_pipelines.py
- list_pipelines_pipelines.py
- update_pipelines.py
- get_cluster_policy_families.py
- list_cluster_policy_families.py
- create_providers.py
- get_providers.py
- list_providers.py
- list_shares_providers.py
- update_providers.py
- create_alerts.py
- create_queries.py
- get_queries.py
- update_queries.py
- list_sql_query_history.py
- create_recipients.py
- get_recipients.py
- list_recipients.py
- rotate_token_recipients.py
- share_permissions_recipients.py
- update_recipients.py
- create_repos.py
- get_repos.py
- list_repos.py
- update_repos.py
- create_schemas.py
- create_shares.py
- create_tables.py
- create_volumes.py
- get_schemas.py
- list_schemas.py
- update_schemas.py
- create_scope_secrets.py
- list_acls_secrets.py
- list_scopes_secrets.py
- list_secrets_secrets.py
- put_acl_secrets.py
- put_secret_secrets.py
- create_create_obo_token_on_aws.py
- create_service_principals_on_aws.py
- get_service_principals_on_aws.py
- list_service_principals_on_aws.py
- patch_service_principals_on_aws.py
- update_service_principals_on_aws.py
- create_shares.py
- get_shares.py
- list_shares.py
- update_shares.py
- execute_shares.py
- execute_tables.py
- create_external_locations.py
- create_external_locations_on_aws.py
- create_storage_credentials.py
- create_storage_credentials_on_aws.py
- create_volumes.py
- get_storage_credentials.py
- get_storage_credentials_on_aws.py
- list_storage_credentials.py
- list_storage_credentials_on_aws.py
- update_storage_credentials.py
- update_storage_credentials_on_aws.py
- get_tables.py
- list_summaries_tables.py
- list_tables.py
- create_obo_token_create_obo_token_on_aws.py
- get_create_obo_token_on_aws.py
- list_create_obo_token_on_aws.py
- create_tokens.py
- get_tokens.py
- list_tokens.py
- create_clusters_api_integration.py
- create_users.py
- create_workspace_users.py
- delete_clusters_api_integration.py
- delete_users.py
- delete_workspace_users.py
- get_users.py
- get_workspace_users.py
- list_users.py
- list_workspace_users.py
- patch_workspace_users.py
- update_workspace_users.py
- create_volumes.py
- list_volumes.py
- read_volumes.py
- update_volumes.py
- create_sql_warehouses.py
- edit_sql_warehouses.py
- get_sql_warehouses.py
- list_sql_warehouses.py
- download_file.py
- export__workspace_integration.py
- export_workspace_integration.py
- get_status_generic_permissions.py
- get_status_workspace_integration.py
- import__generic_permissions.py
- import__jobs_api_full_integration.py
- import__pipelines.py
- import__workspace_integration.py
- import_generic_permissions.py
- import_jobs_api_full_integration.py
- import_pipelines.py
- import_workspace_integration.py
- list_recursive.py
- list_workspace_integration.py
- upload_notebook.py
- get_catalog_workspace_bindings.py
- update_catalog_workspace_bindings.py
- get_status_repos.py
- custom_auth.py
- external_browser_auth.py
- flask_app_with_oauth.py
- last_job_runs.py
- list_compute_submitrun_runs.py
- local_browser_oauth.py
- starting_job_and_waiting.py
- httpcallv2.py
- idempotencytesting.py
- jsonmarshallv2.py
- lrotesting.py
- test_http_call.py
- test_idempotency.py
- test_json_marshall.py
- test_lro_call.py
- __init__.py
- conftest.py
- test_auth.py
- test_client.py
- test_clusters.py
- test_commands.py
- test_data_plane.py
- test_dbconnect.py
- test_dbutils.py
- test_deployment.py
- test_external_browser.py
- test_files.py
- test_iam.py
- test_jobs.py
- test_repos.py
- test_settings.py
- test_sql.py
- test_unified_profile.py
- test_workspace.py
- .databrickscfg
- .databrickscfg
- .databrickscfg
- az.ps1
- .databrickscfg
- az
- model-serving-test-token
- model-serving-test-token-v2
- test_casing.py
- __init__.py
- clock.py
- conftest.py
- fixture_server.py
- test_auth.py
- test_auth.py.tmpl
- test_auth_manual_tests.py
- test_auth_profiles.py
- test_base_client.py
- test_client.py
- test_compute_mixins.py
- test_config.py
- test_core.py
- test_credentials_provider.py
- test_custom_headers.py
- test_data_plane.py
- test_dbfs_mixins.py
- test_dbutils.py
- test_default_profile.py
- test_environments.py
- test_errors.py
- test_fieldmask.py
- test_files.py
- test_files_utils.py
- test_init_file.py
- test_internal.py
- test_jobs_mixin.py
- test_metadata_service_auth.py
- test_misc.py
- test_model_serving_auth.py
- test_notebook_oauth.py
- test_oauth.py
- test_oidc.py
- test_oidc_token_supplier.py
- test_open_ai_mixin.py
- test_refreshable.py
- test_retries.py
- test_runtime.py
- test_user_agent.py
- .codegen.json
- .gitattributes
- .gitignore
- .package.json
- .readthedocs.yaml
- .release_metadata.json
- CHANGELOG.md
- CONTRIBUTING.md
- DCO
- docs-requirements.txt
- LICENSE
- Makefile
- MANIFEST.in
- NOTICE
- pyproject.toml
- README.md
- SECURITY.md
- setup.cfg
- tagging.py.lock
- uv.lock
# Installation Guide
1. Get the code
git clone https://github.com/databricks/databricks-sdk-py
Downloads the entire project code from GitHub to your computer.
cd databricks-sdk-py
Moves into the project folder you just downloaded.
2. Python
Easy RecommendedPrerequisites
%pip install --upgrade databricks-sdk
Installs the Python libraries listed in requirements.txt (or similar).
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
3. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)