How to connect to data on Azure Blob Storage using Spark
This guide will help you connect to your data stored on Microsoft Azure Blob Storage (ABS) using Spark. This will allow you to validate and explore your data.
Prerequisites: This how-to guide assumes you have:
- Completed the Getting Started Tutorial
- Have a working installation of Great Expectations
- Have access to data on an ABS container
- Have access to a working Spark installation
Steps#
1. Choose how to run the code in this guide#
Get an environment to run the code in this guide. Please choose an option below.
- CLI + filesystem
- No CLI + filesystem
- No CLI + no filesystem
If you use the Great Expectations CLI, run this command to automatically generate a pre-configured Jupyter Notebook. Then you can follow along in the YAML-based workflow below:
great_expectations --v3-api datasource newIf you use Great Expectations in an environment that has filesystem access, and prefer not to use the CLI, run the code in this guide in a notebook or other Python script.
If you use Great Expectations in an environment that has no filesystem (such as Databricks or AWS EMR), run the code in this guide in that system's preferred way.
2. Instantiate your project's DataContext#
Import these necessary packages and modules.
from ruamel import yaml
import great_expectations as gefrom great_expectations.core.batch import Batch, BatchRequestLoad your DataContext into memory
Use one of the guides below based on your deployment:
Please proceed only after you have instantiated your DataContext.
3. Configure your Datasource#
Using this example configuration, add in your ABS container and path to a directory that contains some of your data:
- YAML
- Python
datasource_yaml = fr"""name: my_azure_datasourceclass_name: Datasourceexecution_engine:    class_name: SparkDFExecutionEngine    azure_options:        account_url: <YOUR_ACCOUNT_URL> # or `conn_str`        credential: <YOUR_CREDENTIAL>   # if using a protected containerdata_connectors:    default_runtime_data_connector_name:        class_name: RuntimeDataConnector        batch_identifiers:            - default_identifier_name    default_inferred_data_connector_name:        class_name: InferredAssetAzureDataConnector        azure_options:            account_url: <YOUR_ACCOUNT_URL> # or `conn_str`            credential: <YOUR_CREDENTIAL>   # if using a protected container        container: <YOUR_AZURE_CONTAINER_HERE>        name_starts_with: <CONTAINER_PATH_TO_DATA>        default_regex:            pattern: (.*)\.csv            group_names:                - data_asset_name"""Authentication
It is also important to note that ABS DataConnector for Spark supports the method of authentication called
Windows Azure Storage Blob Secure ("WASBS"), which requires the AZURE_ACCESS_KEY environment variable to be set.
For more details regarding authentication, please visit the following:
Run this code to test your configuration.
context.test_yaml_config(datasource_yaml)datasource_config = {    "name": "my_azure_datasource",    "class_name": "Datasource",    "execution_engine": {        "class_name": "SparkDFExecutionEngine",        "azure_options": {            "account_url": "<YOUR_ACCOUNT_URL>",            "credential": "<YOUR_CREDENTIAL>",        },    },    "data_connectors": {        "default_inferred_data_connector_name": {            "class_name": "InferredAssetAzureDataConnector",            "azure_options": {                "account_url": "<YOUR_ACCOUNT_URL>",                "credential": "<YOUR_CREDENTIAL>",            },            "container": "<YOUR_CONTAINER>",            "name_starts_with": "<CONTAINER_PATH_TO_DATA>",            "default_regex": {                "pattern": "(.*)\\.csv",                "group_names": ["data_asset_name"],            },        },    },}Run this code to test your configuration.
context.test_yaml_config(yaml.dump(datasource_config))If you specified an ABS path containing CSV files you will see them listed as Available data_asset_names in the output of test_yaml_config().
Feel free to adjust your configuration and re-run test_yaml_config() as needed.
4. Save the Datasource configuration to your DataContext#
Save the configuration into your DataContext by using the add_datasource() function.
- YAML
- Python
context.add_datasource(**yaml.load(datasource_yaml))context.add_datasource(**datasource_config)5. Test your new Datasource#
Verify your new Datasource by loading data from it into a Validator using a BatchRequest.
Add the name of the data asset to the data_asset_name in your BatchRequest.
batch_request = BatchRequest(    datasource_name="my_azure_datasource",    data_connector_name="default_inferred_data_connector_name",    data_asset_name="<YOUR_DATA_ASSET_NAME>",    batch_spec_passthrough={"reader_method": "csv", "reader_options": {"header": True}},)Then load data into the Validator.
context.create_expectation_suite(    expectation_suite_name="test_suite", overwrite_existing=True)validator = context.get_validator(    batch_request=batch_request, expectation_suite_name="test_suite")ππ Congratulations! ππ You successfully connected Great Expectations with your data.
Additional Notes#
If you are working with nonstandard CSVs, read one of these guides:
- How to work with headerless CSVs in Spark
- How to work with custom delimited CSVs in Spark
- How to work with parquet files in Spark
To view the full scripts used in this page, see them on GitHub:
- spark_configured_azure_yaml_example.py
- spark_configured_azure_python_example.py
- spark_inferred_and_runtime_azure_yaml_example.py
- spark_inferred_and_runtime_azure_python_example.py
Next Steps#
Now that you've connected to your data, you'll want to work on these core skills: