.. Databricks Labs Data Generator documentation master file, created by
   sphinx-quickstart on Sun Jun 21 10:54:30 2020.

Databricks Labs Data Generator Documentation
============================================

The Databricks Labs Data Generator project provides a convenient way to
generate large volumes of synthetic data from within a Databricks notebook (or a regular Spark application).

By defining a data generation spec, either in conjunction with an existing schema
or through creating a schema on the fly, you can control how synthetic data is generated.

As the data generator generates a PySpark data frame, it is simple to create a view over it to expose it
to Scala or R-based Spark applications also.

As it is installable via `%pip install`, it can also be incorporated in environments such as
`Delta Live Tables <https://www.databricks.com/product/delta-live-tables>`_ also.

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   Get Started Here <APIDOCS>
   Installation instructions <installation_notes>
   Generating column data <generating_column_data>
   Using data ranges <DATARANGES>
   Generating text data <textdata>
   Using data distributions <DISTRIBUTIONS>
   Options for column specification <options_and_features>
   Generating repeatable data <repeatable_data_generation>
   Using streaming data <using_streaming_data>
   Generating JSON and structured column data <generating_json_data>
   Generating synthetic data from existing data <generating_from_existing_data>
   Generating Change Data Capture (CDC) data <generating_cdc_data>
   Using multiple tables <multi_table_data>
   Extending text generation <extending_text_generation>
   Use with Delta Live Tables <using_delta_live_tables>
   Troubleshooting data generation <troubleshooting>

.. toctree::
   :maxdepth: 1
   :caption: API

   Quick API index <relnotes/quickindex>
   The dbldatagen package API <reference/api/modules>

.. toctree::
   :maxdepth: 1
   :caption: Development

   Building and contributing <relnotes/CONTRIBUTING>
   Change log <relnotes/CHANGELOG>
   Build requirements <relnotes/requirements>

.. toctree::
   :maxdepth: 1
   :caption: License

   license

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`