Skip to content

Commit 6e8c9f5

Browse files
docs: add project-level case_sensitive option to lightdash.config.yml (#463)
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent 0bd27a5 commit 6e8c9f5

3 files changed

Lines changed: 54 additions & 4 deletions

File tree

references/dimensions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1259,7 +1259,7 @@ This setting affects the following filter operators: `equals`, `not equals`, `st
12591259
With `case_sensitive: false`, filtering for "john" would match "John", "JOHN", "john", etc.
12601260

12611261
<Info>
1262-
Dimension-level `case_sensitive` settings override any explore-level `case_sensitive` setting. See [Tables reference](/references/tables#case-sensitive) for explore-level configuration.
1262+
Dimension-level `case_sensitive` settings override explore-level and project-level settings. See [Tables reference](/references/tables#case-sensitive) for explore-level configuration and [lightdash.config.yml reference](/references/lightdash-config-yml#defaults-configuration) for project-level defaults.
12631263
</Info>
12641264

12651265

references/lightdash-config-yml.mdx

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "lightdash.config.yml reference"
3-
description: 'The lightdash.config.yml file allows you to configure project-wide settings for your Lightdash project, including spotlight and parameters.'
3+
description: 'The lightdash.config.yml file allows you to configure project-wide settings for your Lightdash project, including spotlight, parameters, and defaults.'
44
sidebarTitle: "lightdash.config.yml"
55
---
66

@@ -89,6 +89,10 @@ spotlight:
8989
# Configuration for project-wide parameters
9090
parameters:
9191
# ...
92+
93+
# Configuration for project-wide defaults
94+
defaults:
95+
# ...
9296
```
9397

9498

@@ -198,4 +202,50 @@ Or using the shorter alias:
198202
${ld.parameters.region}
199203
```
200204

201-
See the [Parameters guide](/guides/developer/using-parameters) for more information on how to use parameters.
205+
See the [Parameters guide](/guides/developer/using-parameters) for more information on how to use parameters.
206+
207+
208+
## Defaults configuration
209+
210+
The `defaults` section allows you to set project-wide default settings that apply across all explores and dimensions. These defaults can be overridden at the explore or dimension level.
211+
212+
```yaml
213+
defaults:
214+
case_sensitive: false
215+
```
216+
217+
| Property | Required | Value | Description |
218+
| :--------------- | :------- | :------ | :---------- |
219+
| `case_sensitive` | No | boolean | Default case sensitivity for string filters across the project. When `false`, all string filters will be case insensitive by default. Defaults to `true`. |
220+
221+
222+
### Case sensitivity hierarchy
223+
224+
The `case_sensitive` setting follows a hierarchy where more specific settings override broader ones:
225+
226+
1. **Dimension-level** (highest priority) - Set on individual dimensions
227+
2. **Explore/table-level** - Set on the explore or table
228+
3. **Project-level** - Set in `lightdash.config.yml` defaults
229+
4. **Default behavior** - Case sensitive (`true`) if nothing is specified
230+
231+
This allows you to set organization-wide defaults while maintaining the flexibility to override them for specific explores or dimensions as needed.
232+
233+
**Example**: Set case insensitivity as the project default, but override for a specific table:
234+
235+
```yaml
236+
# lightdash.config.yml
237+
defaults:
238+
case_sensitive: false # Project-wide default
239+
```
240+
241+
```yaml
242+
# In your model yml file - override for a specific table
243+
models:
244+
- name: case_sensitive_table
245+
meta:
246+
case_sensitive: true # Override: this table uses case sensitive filters
247+
```
248+
249+
<Info>
250+
See [Tables reference](/references/tables#case-sensitive) for explore-level configuration and [Dimensions reference](/references/dimensions#case-sensitive) for dimension-level configuration.
251+
</Info>

references/tables.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -943,7 +943,7 @@ This setting affects the following filter operators: `equals`, `not equals`, `st
943943
With `case_sensitive: false`, filtering for "john" on any string dimension would match "John", "JOHN", "john", etc.
944944

945945
<Info>
946-
Dimension-level `case_sensitive` settings override the table-level setting. See [Dimensions reference](/references/dimensions#case-sensitive) for dimension-level configuration.
946+
Table-level `case_sensitive` settings override the project-level default. Dimension-level settings override both. See [Dimensions reference](/references/dimensions#case-sensitive) for dimension-level configuration and [lightdash.config.yml reference](/references/lightdash-config-yml#defaults-configuration) for project-level defaults.
947947
</Info>
948948

949949
## Parameters configuration

0 commit comments

Comments
 (0)