databricks-cli/libs/template/templates/default-sql/template/{{.project_name}}
Shreyas Goenka 9b2fe7cfa9
fix references to the files
2024-09-18 11:44:15 +02:00
..
.vscode Add an experimental default-sql template (#1051) 2024-02-19 12:01:11 +00:00
resources Rename resource files in build-in templates to have a <resource-name>.yml file extension 2024-09-18 11:26:36 +02:00
scratch Add an experimental default-sql template (#1051) 2024-02-19 12:01:11 +00:00
src fix references to the files 2024-09-18 11:44:15 +02:00
README.md.tmpl Add an experimental default-sql template (#1051) 2024-02-19 12:01:11 +00:00
databricks.yml.tmpl Include a permissions section in all templates (#1713) 2024-09-03 07:51:54 +00:00

README.md.tmpl

# {{.project_name}}

The '{{.project_name}}' project was generated by using the default-sql template.

## Getting started

1. Install the Databricks CLI from https://docs.databricks.com/dev-tools/cli/install.html

2. Authenticate to your Databricks workspace (if you have not done so already):
    ```
    $ databricks configure
    ```

3. To deploy a development copy of this project, type:
    ```
    $ databricks bundle deploy --target dev
    ```
    (Note that "dev" is the default target, so the `--target` parameter
    is optional here.)

    This deploys everything that's defined for this project.
    For example, the default template would deploy a job called
    `[dev yourname] {{.project_name}}_job` to your workspace.
    You can find that job by opening your workpace and clicking on **Workflows**.

4. Similarly, to deploy a production copy, type:
   ```
   $ databricks bundle deploy --target prod
   ```

5. To run a job, use the "run" command:
   ```
   $ databricks bundle run
   ```

6. Optionally, install developer tools such as the Databricks extension for Visual Studio Code from
   https://docs.databricks.com/dev-tools/vscode-ext.html.

7. For documentation on the Databricks Asset Bundles format used
   for this project, and for CI/CD configuration, see
   https://docs.databricks.com/dev-tools/bundles/index.html.