Config: add project-index default for render

Signed-off-by: Andreas Fredhøi <andreas.fredhoi@fresio.no>

Author: fresioAS

docs/examples/sqlmesh_cli_crash_course.md

@@ -738,6 +738,11 @@ You'll use these commands as needed to validate that your changes are behaving a
 
 This is a great way to verify that your model's SQL is looking as expected before applying the changes. It is especially important if you're migrating from one query engine to another (ex: postgres to databricks).
 
+In large projects, add `--use-project-index` to load only the model being rendered and its upstream
+dependencies. To enable this behavior by default, set
+[`render.use_project_index`](../reference/configuration.md#render) to `true` in the project
+configuration.
+
 === "SQLMesh"
 
     ```bash
@@ -1254,4 +1259,4 @@ If you notice you have a lot of old development schemas/data, you can clean them
 
     ```bash
     tcloud sqlmesh janitor
-    ```
+    ```

docs/guides/configuration.md

@@ -90,6 +90,7 @@ The `config` sub-module API documentation describes the individual classes used
     - [Connection configuration](https://sqlmesh.readthedocs.io/en/latest/_readthedocs/html/sqlmesh/core/config/connection.html) (separate classes for each supported database/engine)
     - [Scheduler configuration](https://sqlmesh.readthedocs.io/en/latest/_readthedocs/html/sqlmesh/core/config/scheduler.html) (separate classes for each supported scheduler)
 - [Plan change categorization configuration](https://sqlmesh.readthedocs.io/en/latest/_readthedocs/html/sqlmesh/core/config/categorizer.html#CategorizerConfig): `CategorizerConfig()`
+- [Render configuration](https://sqlmesh.readthedocs.io/en/latest/_readthedocs/html/sqlmesh/core/config/render.html): `RenderConfig()`
 - [User configuration](https://sqlmesh.readthedocs.io/en/latest/_readthedocs/html/sqlmesh/core/user.html#User): `User()`
 - [Notification configuration](https://sqlmesh.readthedocs.io/en/latest/_readthedocs/html/sqlmesh/core/notification_target.html) (separate classes for each notification target)
 
@@ -331,7 +332,7 @@ The cache directory is automatically created if it doesn't exist. You can clear
 
 #### Project index
 
-The `--use-project-index` option on supported commands maintains a persistent model dependency index in the cache directory. Each project writes a file named `<project>_<hash>_model_index.json`.
+The `--use-project-index` option on the `lint` and `render` commands maintains a persistent model dependency index in the cache directory. Each project writes a file named `<project>_<hash>_model_index.json`. The option can be enabled by default for each command with `linter.use_project_index` or `render.use_project_index`, respectively.
 
 A full project load with the option enabled creates or refreshes the index. SQLMesh invalidates it when relevant configuration, gateway, macro, audit, or signal metadata changes, or when the set of model files changes. If the index is missing, invalid, or stale, SQLMesh safely falls back to a full project load and rebuilds it.
 
@@ -1503,6 +1504,35 @@ SQLMesh provides a linter that checks for potential issues in your models' code.
 
 Learn more about linting configuration in the [linting guide](./linter.md).
 
+### Rendering
+
+By default, `sqlmesh render` loads every model in the project. In large projects, you can use the
+persistent project index to load only the model being rendered and its transitive upstream
+dependencies. Enable indexed rendering for an individual command with `--use-project-index`, or
+make it the project default with the `render.use_project_index` configuration option.
+
+=== "YAML"
+
+    ```yaml linenums="1"
+    render:
+      use_project_index: true
+    ```
+
+=== "Python"
+
+    ```python linenums="1"
+    from sqlmesh.core.config import Config, ModelDefaultsConfig, RenderConfig
+
+    config = Config(
+        model_defaults=ModelDefaultsConfig(dialect="duckdb"),
+        render=RenderConfig(use_project_index=True),
+    )
+    ```
+
+`Context.render` uses the configured value when `use_project_index` is omitted. Passing
+`use_project_index=False` explicitly disables indexed rendering for that API call. See the
+[`render` CLI reference](../reference/cli.md#render) for the other rendering options.
+
 ### Debug mode
 
 To enable debug mode set the `SQLMESH_DEBUG` environment variable to one of the following values: "1", "true", "t", "yes" or "y".

docs/reference/cli.md

@@ -449,7 +449,8 @@ Options:
   --no-format                 Disable fancy formatting of the query.
   --use-project-index         Use the persistent project index to load and
                               render only the target model and its upstream
-                              dependencies.
+                              dependencies. Can also be enabled with
+                              render.use_project_index.
   --max-text-width INTEGER    The max number of characters in a segment before
                               creating new lines in pretty mode.
   --leading-comma             Determines whether or not the comma is leading

docs/reference/configuration.md

@@ -67,6 +67,12 @@ See all the keys allowed in `model_defaults` at the [model configuration referen
 | `linter.enabled`          | Whether linting is enabled (Default: `False`)                                                                                                      | boolean | N        |
 | `linter.use_project_index` | Whether to use the persistent project index for linting. Targeted linting loads selected models and their upstream dependencies. (Default: `False`) | boolean | N        |
 
+### Render
+
+| Option                     | Description                                                                                                                                                       | Type    | Required |
+|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|----------|
+| `render.use_project_index` | Whether to use the persistent project index when rendering. Only the target model and its upstream dependencies are loaded. (Default: `False`)                    | boolean | N        |
+
 ### Variables
 
 The `variables` key can be used to provide values for user-defined variables, accessed using the [`@VAR` macro function](../concepts/macros/sqlmesh_macros.md#global-variables) in SQL model definitions, [`context.var` method](../concepts/models/python_models.md#global-variables) in Python model definitions, and [`evaluator.var` method](../concepts/macros/sqlmesh_macros.md#accessing-global-variable-values) in Python macro functions.

sqlmesh/cli/main.py

@@ -287,7 +287,8 @@ def init(
 @click.option(
     "--use-project-index",
     is_flag=True,
-    help="Use the persistent project index to load and render only the target model and its upstream dependencies.",
+    default=None,
+    help="Use the persistent project index to load and render only the target model and its upstream dependencies. Can also be enabled with render.use_project_index.",
 )
 @opt.format_options
 @click.pass_context
@@ -302,7 +303,7 @@ def render(
     expand: t.Optional[t.Union[bool, t.Iterable[str]]] = None,
     dialect: t.Optional[str] = None,
     no_format: bool = False,
-    use_project_index: bool = False,
+    use_project_index: t.Optional[bool] = None,
     **format_kwargs: t.Any,
 ) -> None:
     """Render a model's query, optionally expanding referenced models."""

sqlmesh/core/config/__init__.py

@@ -37,6 +37,7 @@
 from sqlmesh.core.config.naming import NameInferenceConfig as NameInferenceConfig
 from sqlmesh.core.config.linter import LinterConfig as LinterConfig
 from sqlmesh.core.config.plan import PlanConfig as PlanConfig
+from sqlmesh.core.config.render import RenderConfig as RenderConfig
 from sqlmesh.core.config.root import Config as Config, DbtConfig as DbtConfig
 from sqlmesh.core.config.run import RunConfig as RunConfig
 from sqlmesh.core.config.scheduler import BuiltInSchedulerConfig as BuiltInSchedulerConfig

sqlmesh/core/config/render.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from sqlmesh.core.config.base import BaseConfig
+
+
+class RenderConfig(BaseConfig):
+    """Configuration for rendering model queries.
+
+    Args:
+        use_project_index: Whether to use the persistent project index when rendering.
+    """
+
+    use_project_index: bool = False

sqlmesh/core/config/root.py

@@ -35,6 +35,7 @@
 from sqlmesh.core.config.naming import NameInferenceConfig as NameInferenceConfig
 from sqlmesh.core.config.linter import LinterConfig as LinterConfig
 from sqlmesh.core.config.plan import PlanConfig
+from sqlmesh.core.config.render import RenderConfig
 from sqlmesh.core.config.run import RunConfig
 from sqlmesh.core.config.dbt import DbtConfig
 from sqlmesh.core.config.scheduler import (
@@ -141,6 +142,7 @@ class Config(BaseConfig):
         format: The formatting options for SQL code.
         ui: The UI configuration for SQLMesh.
         plan: The plan configuration.
+        render: The render configuration.
         migration: The migration configuration.
         variables: A dictionary of variables that can be used in models / macros.
         disable_anonymized_analytics: Whether to disable the anonymized analytics collection.
@@ -183,6 +185,7 @@ class Config(BaseConfig):
     format: FormatConfig = FormatConfig()
     ui: UIConfig = UIConfig()
     plan: PlanConfig = PlanConfig()
+    render: RenderConfig = RenderConfig()
     migration: MigrationConfig = MigrationConfig()
     model_naming: NameInferenceConfig = NameInferenceConfig()
     variables: t.Dict[str, t.Any] = {}
@@ -208,6 +211,7 @@ class Config(BaseConfig):
         "ui": UpdateStrategy.NESTED_UPDATE,
         "loader_kwargs": UpdateStrategy.KEY_UPDATE,
         "plan": UpdateStrategy.NESTED_UPDATE,
+        "render": UpdateStrategy.NESTED_UPDATE,
         "before_all": UpdateStrategy.EXTEND,
         "after_all": UpdateStrategy.EXTEND,
         "linter": UpdateStrategy.NESTED_UPDATE,

sqlmesh/core/context.py

@@ -1199,7 +1199,7 @@ def render(
         end: t.Optional[TimeLike] = None,
         execution_time: t.Optional[TimeLike] = None,
         expand: t.Union[bool, t.Iterable[str]] = False,
-        use_project_index: bool = False,
+        use_project_index: t.Optional[bool] = None,
         **kwargs: t.Any,
     ) -> exp.Expr:
         """Renders a model's query, expanding macros with provided kwargs, and optionally expanding referenced models.
@@ -1213,12 +1213,16 @@ def render(
                 If True, all referenced models are expanded as raw queries.
                 If a list, only referenced models are expanded as raw queries.
             use_project_index: Whether to use the persistent project index to load and
-                render only the target model and its transitive upstream dependencies.
+                render only the target model and its transitive upstream dependencies. If
+                omitted, the value of ``render.use_project_index`` is used.
 
         Returns:
             The rendered expression.
         """
         execution_time = execution_time or now()
+        use_project_index = (
+            self.config.render.use_project_index if use_project_index is None else use_project_index
+        )
 
         if not self._loaded:
             target_fqns = (

tests/core/test_config.py

@@ -16,6 +16,7 @@
     ModelDefaultsConfig,
     BigQueryConnectionConfig,
     MotherDuckConnectionConfig,
+    RenderConfig,
     BuiltInSchedulerConfig,
     EnvironmentSuffixTarget,
     TableNamingConvention,
@@ -70,6 +71,13 @@ def python_config_path(tmp_path_factory) -> Path:
     return config_path
 
 
+def test_render_config() -> None:
+    config = Config.parse_obj({"render": {"use_project_index": True}})
+
+    assert config.render == RenderConfig(use_project_index=True)
+    assert Config().update_with(config).render.use_project_index is True
+
+
 def test_update_with_gateways():
     gateway0_config = GatewayConfig(connection=DuckDBConnectionConfig())
     gateway1_config = GatewayConfig(connection=DuckDBConnectionConfig(database="test"))