Skip to content

Commit

Permalink
word updates
Browse files Browse the repository at this point in the history
  • Loading branch information
dwreeves committed Jan 1, 2024
1 parent 8de5d55 commit 142eb32
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/configuration/parsing-methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ There are benefits and drawbacks to each method:
- ``dbt_manifest``: You have to generate the manifest file on your own. When using the manifest, Cosmos gets a complete set of metadata about your models. However, Cosmos uses its own selecting & excluding logic to determine which models to run, which may not be as robust as dbt's.
- ``dbt_ls``: Cosmos will generate the manifest file for you. This method uses dbt's metadata AND dbt's selecting/excluding logic. This is the most robust method. However, this requires the dbt executable to be installed on your machine (either on the host directly or in a virtual environment).
- ``dbt_ls_file`` (new in 1.3): Path to a file containing the ``dbt ls`` output. To use this method, run ``dbt ls`` using ``--output json`` and store the output in a file. ``RenderConfig.select`` and ``RenderConfig.exclude`` will not work using this method.
- ``custom``: Cosmos will parse your project and model files for you. This means that Cosmos will not have access to dbt's metadata. However, this method does not require the dbt executable to be installed on your machine.
- ``custom``: Cosmos will parse your project and model files for you. This means that Cosmos will not have access to dbt's metadata. However, this method does not require the dbt executable to be installed on your machine, and does not require the user to provide any dbt artifacts.

If you're using the ``local`` mode, you should use the ``dbt_ls`` method.

Expand Down
5 changes: 4 additions & 1 deletion docs/getting_started/gcc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Make a new folder, ``dbt``, inside your local ``dags`` folder. Then, copy/paste

Note: your dbt projects can go anywhere that Airflow can read. By default, Cosmos looks in the ``/usr/local/airflow/dags/dbt`` directory, but you can change this by setting the ``dbt_project_dir`` argument when you create your DAG instance.

Additionally, Cosmos will need your dbt project's ``manifest.json`` to be pre-compiled (include ``dbt deps && dbt compile`` as part of your deployment process).
For more accurate parsing of your dbt project, you should pre-compile your dbt project's ``manifest.json`` (include ``dbt deps && dbt compile`` as part of your deployment process).

For example, if you wanted to put your dbt project in the ``/usr/local/airflow/dags/my_dbt_project`` directory, you would do:

Expand All @@ -39,6 +39,9 @@ For example, if you wanted to put your dbt project in the ``/usr/local/airflow/d
)
.. note::
You can also exclude the ``manifest_path=...`` from the ``ProjectConfig``. Excluding a ``manifest_path`` file will by default use Cosmos's ``custom`` parsing method, which may be less accurate at parsing a dbt project compared to providing a ``manifest.json``.

Create your DAG
---------------

Expand Down

0 comments on commit 142eb32

Please sign in to comment.