Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion THIRD-PARTY-NOTICES
Original file line number Diff line number Diff line change
Expand Up @@ -2290,7 +2290,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
------------------------------------------------------------------------------
dfe-schemas 0.2.27 (LicenseRef-HyperI)
dfe-schemas 0.2.29 (LicenseRef-HyperI)
------------------------------------------------------------------------------

Business Source License 1.1
Expand Down
12 changes: 6 additions & 6 deletions docs/data-plane/external-pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,13 +105,13 @@ Nothing makes your records carry the DFE common header. The loader fills in a mi

| Field | Missing, the loader | Set, you get |
|---|---|---|
| `_timestamp` | reads `timestamp`, then `@timestamp`, and takes the load time when neither is there | the event's own time, so time-range queries and retention follow when it happened |
| `_org_id` | lands the record in the source's org | the source's org or one `allowed_org_ids` lists, which is how a provider lands each customer in their own org |
| `_source` | takes it from the topic name, which is this source | this source or one `allowed_sources` lists, which picks the table |
| `_tags` | reads `tags`, then `meta`, then `metadata.tags`, and leaves it empty when none is there | tags a query or an alert can filter on without parsing the payload |
| `_timestamp_received` | takes the load time | when your pipeline first saw the event, so you can measure the delay before DFE |
| `_timestamp` | reads `timestamp`, and takes the load time when it is not there | the event's own time, so time-range queries and retention follow when it happened |
| `_org_id` | reads `_org_id`, and lands the record in the source's org when it is not there | the source's org or one `allowed_org_ids` lists, which is how a provider lands each customer in their own org |
| `_source` | reads `_source`, and takes the topic name, which is this source, when it is not there | this source or one `allowed_sources` lists, which picks the table |
| `_tags` | reads `_tags`, then `tags`, then `meta`, then `metadata.tags`, and leaves it empty when none is there | tags a query or an alert can filter on without parsing the payload |
| `_timestamp_received` | reads `_timestamp_received`, then `timestamp_received`, then `received_at`, and takes the load time when none is there | when your pipeline first saw the event, so you can measure the delay before DFE |

`_timestamp_load`, `_uuid`, `_json` and `_raw` are always written by the loader and ClickHouse, and a value you send isn't read. The columns come from the source's header profile in dfe-schemas (`common-header/`), and the default profile is `timeseries`.
`_timestamp_load`, `_uuid`, `_json` and `_raw` are always written by the loader and ClickHouse, and a value you send isn't read. The columns and the order the loader reads them in come from the source's header profile in dfe-schemas (`common-header/`), and the default profile is `timeseries`.

A compliant record looks like this:

Expand Down
2 changes: 2 additions & 0 deletions docs/data-plane/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,8 @@ catalogue:
| **Enum** | `Enum8(...)`, `Enum16(...)` |
| **Special** | `Dynamic`, `Variant(...)`, `AggregateFunction(...)`, `SimpleAggregateFunction(...)` |

`GET /api/v1/schemas/vocabulary` serves what a schema form offers, read from this registry: the primitives, the index use cases with their labels and the names they replaced, the attributes, the cardinalities with their default, and the override types with the primitive each refines. A type that takes parameters carries a `template` such as `Decimal({precision},{scale})`, so a form builds the override text without knowing the type. A label the registry does not declare reads off the entry's name. The retired `lowcardinality` attribute is not offered: a column declares `cardinality`, and the vocabulary says a stored `lowcardinality` reads as `low`.

---

## Cardinality Axis
Expand Down
5 changes: 3 additions & 2 deletions docs/reference/api-route-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ One row per operation the engine serves today. **New** is where it goes, and its
|---|---|---|
| moved | 87 | A new path, method or both |
| merged into | 9 | Folded into the operation **New** names |
| unchanged | 41 | Same method and path |
| unchanged | 42 | Same method and path |
| frozen | 54 | Kept as it is |
| decide | 129 | Not placed yet: see its question |
| removed | 0 | Gone, with nothing in its place |
| total | 320 | |
| total | 321 | |

## Questions

Expand Down Expand Up @@ -180,6 +180,7 @@ One row per operation the engine serves today. **New** is where it goes, and its
| `DELETE /api/v1/schemas/definitions/{schema_path}/versions/{version}` | `DELETE /api/v1/schemas/{schema}/versions/{version}` | `schemas.versions.delete` | `dfe schemas versions delete` | `dfe_schemas_versions_delete` | moved | ui 2 | |
| `POST /api/v1/schemas/elastic-converter` | `POST /api/v1/schemas/elastic-converter` | `schemas.elastic-converter` | `dfe schemas elastic-converter` | `dfe_schemas_elastic_converter` | unchanged | ui 2 | |
| `POST /api/v1/schemas/import` | `POST /api/v1/schemas/import` | `schemas.import` | `dfe schemas import` | `dfe_schemas_import` | unchanged | 0 | |
| `GET /api/v1/schemas/vocabulary` | `GET /api/v1/schemas/vocabulary` | `schemas.vocabulary` | `dfe schemas vocabulary` | `dfe_schemas_vocabulary` | unchanged | 0 | |

## sources

Expand Down
Loading
Loading