Skip to content

docs: fix cached lookup module documentation #17527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abhishekrb19 merged 2 commits into from
Dec 6, 2024
Merged

docs: fix cached lookup module documentation #17527

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1de426c
docs: fix loading lookup documentation
TessaIO Dec 2, 2024
baff220
docs: fix indentation and punctuation
TessaIO Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 74 additions & 15 deletions docs/development/extensions-core/druid-lookups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,22 @@ This example demonstrates a polling cache that will update its on-heap cache eve

```json
{
"type":"pollingLookup",
"pollPeriod":"PT10M",
"dataFetcher":{ "type":"jdbcDataFetcher", "connectorConfig":"jdbc://mysql://localhost:3306/my_data_base", "table":"lookup_table_name", "keyColumn":"key_column_name", "valueColumn": "value_column_name"},
"cacheFactory":{"type":"onHeapPolling"}
"type": "pollingLookup",
"pollPeriod": "PT10M",
"dataFetcher": {
"type": "jdbcDataFetcher",
"connectorConfig": {
"connectURI": "jdbc://mysql://localhost:3306/my_data_base",
"user": "druid",
"password": "druid"
},
"table": "lookup_table_name",
"keyColumn": "key_column_name",
"valueColumn": "value_column_name"
},
"cacheFactory": {
"type": "onHeapPolling"
}
}

```
Expand All @@ -94,9 +106,21 @@ This example demonstrates an off-heap lookup that will be cached once and never

```json
{
"type":"pollingLookup",
"dataFetcher":{ "type":"jdbcDataFetcher", "connectorConfig":"jdbc://mysql://localhost:3306/my_data_base", "table":"lookup_table_name", "keyColumn":"key_column_name", "valueColumn": "value_column_name"},
"cacheFactory":{"type":"offHeapPolling"}
"type": "pollingLookup",
"dataFetcher": {
"type": "jdbcDataFetcher",
"connectorConfig": {
"connectURI": "jdbc://mysql://localhost:3306/my_data_base",
"user": "druid",
"password": "druid"
},
"table": "lookup_table_name",
"keyColumn": "key_column_name",
"valueColumn": "value_column_name"
},
"cacheFactory": {
"type": "offHeapPolling"
}
}

```
Expand Down Expand Up @@ -125,10 +149,27 @@ Guava cache configuration spec.

```json
{
"type":"loadingLookup",
"dataFetcher":{ "type":"jdbcDataFetcher", "connectorConfig":"jdbc://mysql://localhost:3306/my_data_base", "table":"lookup_table_name", "keyColumn":"key_column_name", "valueColumn": "value_column_name"},
"loadingCacheSpec":{"type":"guava"},
"reverseLoadingCacheSpec":{"type":"guava", "maximumSize":500000, "expireAfterAccess":100000, "expireAfterWrite":10000}
"type": "loadingLookup",
"dataFetcher": {
"type": "jdbcDataFetcher",
"connectorConfig": {
"connectURI": "jdbc://mysql://localhost:3306/my_data_base",
"user": "druid",
"password": "druid"
},
"table": "lookup_table_name",
"keyColumn": "key_column_name",
"valueColumn": "value_column_name"
},
"loadingCacheSpec": {
"type": "guava"
},
"reverseLoadingCacheSpec": {
"type": "guava",
"maximumSize": 500000,
"expireAfterAccess": 100000,
"expireAfterWrite": 10000
}
}
```

Expand All @@ -146,10 +187,28 @@ Off heap cache is backed by [MapDB](http://www.mapdb.org/) implementation. MapDB

```json
{
"type":"loadingLookup",
"dataFetcher":{ "type":"jdbcDataFetcher", "connectorConfig":"jdbc://mysql://localhost:3306/my_data_base", "table":"lookup_table_name", "keyColumn":"key_column_name", "valueColumn": "value_column_name"},
"loadingCacheSpec":{"type":"mapDb", "maxEntriesSize":100000},
"reverseLoadingCacheSpec":{"type":"mapDb", "maxStoreSize":5, "expireAfterAccess":100000, "expireAfterWrite":10000}
"type": "loadingLookup",
"dataFetcher": {
"type": "jdbcDataFetcher",
"connectorConfig": {
"connectURI": "jdbc://mysql://localhost:3306/my_data_base",
"user": "druid",
"password": "druid"
},
"table": "lookup_table_name",
"keyColumn": "key_column_name",
"valueColumn": "value_column_name"
},
"loadingCacheSpec": {
"type": "mapDb",
"maxEntriesSize": 100000
},
"reverseLoadingCacheSpec": {
"type": "mapDb",
"maxStoreSize": 5,
"expireAfterAccess": 100000,
"expireAfterWrite": 10000
}
}
```

Expand Down