|
1 | 1 | --- |
2 | 2 | title: "Use dbt Copilot" |
3 | 3 | sidebar_label: "Use dbt Copilot" |
4 | | -description: "Use the dbt Copilot AI engine to generate documentation, tests, and semantic models from scratch, giving you the flexibility to modify or fix generated code." |
| 4 | +description: "Use dbt Copilot to generate documentation, tests, semantic models, and inline sql code from scratch, giving you the flexibility to modify or fix generated code." |
5 | 5 | --- |
6 | 6 |
|
7 | 7 | # Use dbt Copilot <Lifecycle status='beta'/> |
8 | 8 |
|
9 | | -Use dbt Copilot to generate documentation, tests, and semantic models from scratch, giving you the flexibility to modify or fix generated code. To access and use this AI engine: |
| 9 | +Use dbt Copilot to generate documentation, tests, semantic models, and inline sql code from scratch, giving you the flexibility to modify or fix generated code. |
10 | 10 |
|
11 | | -1. Navigate to the dbt Cloud IDE and select a SQL model file under the **File Explorer**. |
| 11 | +This page explains how to use dbt Copilot to: |
12 | 12 |
|
13 | | -2. In the **Console** section (under the **File Editor**), click **dbt Copilot** to view the available AI options. |
| 13 | +- [Generate resources](#generate-resources) — Save time by using dbt Copilot’s generation button to generate documentation, tests, and semantic model files during your development. |
| 14 | +- [Generate inline sql code](#generate-inline-sql-code) — Use natural language prompts to generate SQL code from scratch or to edit existing SQL file by using keyboard shortcuts or highlighting code. |
| 15 | + |
| 16 | +## Generate resources |
14 | 17 |
|
| 18 | +Generate documentation, tests, and semantic models resources with the click-of-a-button using dbt Copilot, saving you time. To access and use this AI feature: |
| 19 | + |
| 20 | +1. Navigate to the dbt Cloud IDE and select a SQL model file under the **File Explorer**. |
| 21 | +2. In the **Console** section (under the **File Editor**), click **dbt Copilot** to view the available AI options. |
15 | 22 | 3. Select the available options to generate the YAML config: **Generate Documentation**, **Generate Tests**, or **Generate Semantic Model**. |
16 | 23 | - To generate multiple YAML configs for the same model, click each option separately. dbt Copilot intelligently saves the YAML config in the same file. |
17 | | - |
18 | 24 | 4. Verify the AI-generated code. You can update or fix the code as needed. |
19 | | - |
20 | 25 | 5. Click **Save As**. You should see the file changes under the **Version control** section. |
21 | 26 |
|
22 | 27 | <Lightbox src="/img/docs/dbt-cloud/cloud-ide/dbt-copilot-doc.gif" width="100%" title="Example of using dbt Copilot to generate documentation in the IDE" /> |
| 28 | + |
| 29 | +## Generate inline SQL <Lifecycle status='beta'/> |
| 30 | + |
| 31 | +dbt Copilot also allows you to generate SQL code directly within the SQL file in the dbt Cloud IDE, using natural language prompts. This means you can rewrite or add specific portions of the SQL file file without needing to edit the entire file. |
| 32 | + |
| 33 | +This intelligent AI tool streamlines SQL development by reducing errors, scaling effortlessly with complexity, and saving valuable time. dbt Copilot's [prompt window](#use-the-prompt-window), accessible by keyboard shortcut, handles repetitive or complex SQL generation effortlessly so you can focus on high-level tasks. |
| 34 | + |
| 35 | +Use Copilot's prompt window for use cases like: |
| 36 | + |
| 37 | +- Writing advanced transformations |
| 38 | +- Performing bulk edits efficiently |
| 39 | +- Crafting complex patterns like regex |
| 40 | + |
| 41 | +### Use the prompt window |
| 42 | + |
| 43 | +Access dbt Copilot's AI prompt window using the keyboard shortcut Cmd+B (Mac) or Ctrl+B (Windows) to: |
| 44 | + |
| 45 | +#### 1. Generate SQL from scratch |
| 46 | +- Use the keyboard shortcuts Cmd+B (Mac) or Ctrl+B (Windows) to generate SQL from scratch. |
| 47 | +- Enter your instructions to generate SQL code tailored to your needs using natural language. |
| 48 | + |
| 49 | +<Lightbox src="/img/docs/dbt-cloud/cloud-ide/copilot-sql-generation-prompt.jpg" width="90%" title="dbt Copilot's prompt window accessible by keyboard shortcut Cmd+B (Mac) or Ctrl+B (Windows)" /> |
| 50 | + |
| 51 | +#### 2. Edit existing SQL code |
| 52 | +- Highlight a section of SQL code and press Cmd+B (Mac) or Ctrl+B (Windows) to open the prompt window for editing. |
| 53 | +- Use this to refine or modify specific code snippets based on your needs. |
| 54 | + |
| 55 | +#### 3. Review changes with the diff view to quickly assess the impact of the changes before making changes |
| 56 | +- When a suggestion is generated, Copilot displays a visual "diff" view to help you compare the proposed changes with your existing code: |
| 57 | + - **Green**: Means new code that will be added if you accept the suggestion. |
| 58 | + - **Red**: Highlights existing code that will be removed or replaced by the suggested changes. |
| 59 | + |
| 60 | +#### 4. Accept or reject suggestions for full control |
| 61 | +- **Accept**: If the generated SQL meets your requirements, click the **Accept** button to apply the changes directly to your `.sql` file directly in the IDE. |
| 62 | +- **Reject**: If the suggestion don’t align with your request/prompt, click **Reject** to discard the generated SQL without making changes and start again. |
| 63 | + |
| 64 | +Once you've accepted a suggestion, you can continue to use the prompt window to generate additional SQL code and commit your changes to the branch. |
| 65 | + |
| 66 | +<Lightbox src="/img/docs/dbt-cloud/cloud-ide/copilot-sql-generation.gif" width="100%" title="Edit existing SQL code using dbt Copilot's prompt window accessible by keyboard shortcut Cmd+B (Mac) or Ctrl+B (Windows)" /> |
| 67 | + |
| 68 | +### Considerations |
| 69 | +Currently, dbt Copilot is focused on generating inline SQL code to streamline development. We're exploring ways to expand its capabilities in the future to further enhance and support your workflow |
0 commit comments