You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add Oxla SQL Reference documentation as beta component
Integrate Oxla SQL documentation into the main Redpanda docs
repository as a new Antora component with beta status, following
the same pattern as Redpanda Connect integration.
## New Content
- **Oxla SQL Reference** (202 pages): Complete SQL reference covering
statements, clauses, data types, functions, mutations, and system
catalogs
- **Security** (6 pages): Access control, roles, privileges, ownership,
and SSL configuration
- **Troubleshooting** (2 pages): Error handling and degraded state
management
- **Total**: 210 AsciiDoc pages with comprehensive navigation
## Component Structure
- `oxla/antora.yml`: Component configuration with beta badging
- `oxla/modules/oxla/`: Landing page and home content
- `oxla/modules/oxla-reference/`: SQL reference documentation
- `oxla/modules/oxla-manage/`: Security and access control
- `oxla/modules/oxla-troubleshoot/`: Troubleshooting guides
## Key Features
- PostgreSQL-compatible SQL reference with detailed function documentation
- Role-based access control and privilege management
- System catalog documentation
- 143 images migrated and optimized for Antora
- Beta status clearly marked with badges and banners
## Configuration Changes
- `local-antora-playbook.yml`: Added oxla content source with separate
start_path to enable component recognition
- Component ordered after Redpanda Connect in navigation (order: 5)
- Beta badge applied via `page-beta` attribute across all Oxla pages
## Quality Assurance
- Zero build warnings or errors specific to Oxla content
- All pages listed in navigation (no orphaned pages)
- Proper AsciiDoc syntax throughout
- Cross-references validated and working
- All images render correctly
This integration enables deprecation of the standalone oxla-docs
repository. Future Oxla documentation updates will be made directly
to this repository.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: modules/manage/pages/schema-reg/schema-id-validation.adoc
+37-9Lines changed: 37 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,11 +37,17 @@ To use schema ID validation:
37
37
38
38
ifndef::env-cloud[]
39
39
By default, server-side schema ID validation is disabled in Redpanda. To enable schema ID validation, change the xref:reference:cluster-properties.adoc#enable_schema_id_validation[`enable_schema_id_validation`] cluster property from its default value of `none` to either `redpanda` or `compat`:
40
+
endif::[]
41
+
42
+
ifdef::env-cloud[]
43
+
By default, server-side schema ID validation is disabled in Redpanda. To enable schema ID validation, change the xref:reference:properties/cluster-properties.adoc#enable_schema_id_validation[`enable_schema_id_validation`] cluster property from its default value of `none` to either `redpanda` or `compat`:
44
+
endif::[]
40
45
41
46
* `none`: Schema validation is disabled (no schema ID checks are done). Associated topic properties cannot be modified.
42
47
* `redpanda`: Schema validation is enabled. Only Redpanda topic properties are accepted.
43
48
* `compat`: Schema validation is enabled. Both Redpanda and compatible topic properties are accepted.
44
49
50
+
ifndef::env-cloud[]
45
51
For example, use `rpk` to set the value of `enable_schema_id_validation` to `redpanda` through the Admin API:
To enable schema ID validation, set the `enable_schema_id_validation` cluster property to either `redpanda` or `compat`:
55
-
56
-
* `none`: Schema validation is disabled (no schema ID checks are done). Associated topic properties cannot be modified.
57
-
* `redpanda`: Schema validation is enabled. Only Redpanda topic properties are accepted.
58
-
* `compat`: Schema validation is enabled. Both Redpanda and compatible topic properties are accepted.
59
-
60
-
See xref:manage:cluster-maintenance/config-cluster.adoc[]
60
+
See xref:manage:cluster-maintenance/config-cluster.adoc[].
61
61
endif::[]
62
62
63
63
=== Set subject name strategy per topic
@@ -87,6 +87,7 @@ When <<enable-schema-id-validation,schema ID validation is enabled>>, Redpanda u
87
87
88
88
To customize the subject name strategy per topic, set the following client topic properties:
89
89
90
+
ifndef::env-cloud[]
90
91
* Set xref:reference:properties/topic-properties.adoc#redpandakeyschemavalidation[`redpanda.key.schema.id.validation`] to `true` to enable key schema ID validation for the topic, and set xref:reference:properties/topic-properties.adoc#redpandakeysubjectnamestrategy[`redpanda.key.subject.name.strategy`] to the desired subject name strategy for keys of the topic (default: `TopicNameStrategy`).
91
92
* Set xref:reference:properties/topic-properties.adoc#redpandavalueschemavalidation[`redpanda.value.schema.id.validation`] to `true` to enable value schema ID validation for the topic, and set xref:reference:properties/topic-properties.adoc#redpandavaluesubjectnamestrategy[`redpanda.value.subject.name.strategy`] to the desired subject name strategy for values of the topic (default: `TopicNameStrategy`).
92
93
@@ -109,11 +110,38 @@ The `redpanda.` properties have corresponding `confluent.` properties.
* Set `redpanda.key.schema.id.validation` to `true` to enable key schema ID validation for the topic, and set `redpanda.key.subject.name.strategy` to the desired subject name strategy for keys of the topic (default: `TopicNameStrategy`).
118
+
* Set `redpanda.value.schema.id.validation` to `true` to enable value schema ID validation for the topic, and set `redpanda.value.subject.name.strategy` to the desired subject name strategy for values of the topic (default: `TopicNameStrategy`).
119
+
120
+
[NOTE]
121
+
====
122
+
The `redpanda.` properties have corresponding `confluent.` properties.
123
+
124
+
|===
125
+
| Redpanda property | Confluent property
126
+
127
+
| `redpanda.key.schema.id.validation`
128
+
| `confluent.key.schema.validation`
129
+
130
+
| `redpanda.key.subject.name.strategy`
131
+
| `confluent.key.subject.name.strategy`
132
+
133
+
| `redpanda.value.schema.id.validation`
134
+
| `confluent.value.schema.validation`
135
+
136
+
| `redpanda.value.subject.name.strategy`
137
+
| `confluent.value.subject.name.strategy`
138
+
|===
139
+
====
140
+
endif::[]
112
141
113
142
The `redpanda.*` and `confluent.*` properties are compatible. Either or both can be set simultaneously.
114
143
115
144
If `subject.name.strategy` is prefixed with `confluent.`, the available subject name strategies must be prefixed with `io.confluent.kafka.serializers.subject.`. For example, `io.confluent.kafka.serializers.subject.TopicNameStrategy`.
116
-
====
117
145
118
146
NOTE: To support schema ID validation for compressed topics, a Redpanda broker decompresses each batch written to it so it can access the schema ID.
Copy file name to clipboardExpand all lines: modules/reference/partials/properties/cluster-properties.adoc
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5011,10 +5011,13 @@ endif::[]
5011
5011
|===
5012
5012
5013
5013
5014
+
// tag::redpanda-cloud[]
5014
5015
=== enable_schema_id_validation
5015
5016
5016
5017
Controls whether Redpanda validates schema IDs in records and which topic properties are enforced.
5017
5018
5019
+
NOTE: Enabling this property will trigger decompression of message batches for topics on which validation is configured, which may lead to a modest increase in CPU load. Redpanda recommends monitoring CPU utilization after topics are configured.
5020
+
5018
5021
Values:
5019
5022
5020
5023
* `none`: Schema validation is disabled (no schema ID checks are done). Associated topic properties cannot be modified.
page-home-intro: 'Oxla is a PostgreSQL-compatible analytical database that provides high-performance SQL query processing. This documentation covers Oxla SQL dialect, including statements, functions, data types, and system configuration.'
* If the access control flag is explicitly set in the configuration file, that setting is always followed
19
+
* If the flag is not explicitly set in the configuration:
20
+
* When Oxla Home is empty, AC will be **enabled** by default
21
+
* When Oxla Home is non-empty, AC will be **enabled** only if it was previously enabled
22
+
23
+
[NOTE]
24
+
====
25
+
For backward compatibility, old Oxla versions did not have access control (AC).
26
+
If you use a new Oxla release with an Oxla Home created by these old versions, AC will be **disabled** by default.
27
+
However, if the Oxla Home comes from an older where AC was likely enabled, then AC will be **enabled** by default.
28
+
This behavior helps maintain security settings appropriate to the Oxla Home’s history.
29
+
====
30
+
31
+
32
+
## Default Superuser
33
+
34
+
Oxla always includes a default superuser account named `oxla` with the initial password `oxla`.
35
+
36
+
* During the first startup, you can set a custom password for the default superuser using the `access_control.initial_password` parameter in the configuration file
37
+
* After setting the password, you can remove this parameter from the configuration
38
+
* You can also change the password later using the <a href="/security/roles#changing-password" target="_blank">ALTER ROLE</a> query
39
+
40
+
[TIP]
41
+
====
42
+
For security reasons, it is highly recommended to change the default superuser password immediately after installation.
43
+
====
44
+
45
+
46
+
## System Catalogs Visibility
47
+
48
+
Users can view rows in system catalog tables only if those rows correspond to objects or reside in schemas to which the user has access.
49
+
For example, in the `information_schema.tables` table, a user can see all tables for which they have any grants,
50
+
as well as all tables in schemas where they have the `USAGE` privilege.
51
+
52
+
## Restrictions
53
+
54
+
* Only superusers have the `SELECT` privilege on internal system tables
55
+
* Privileges on internal system tables cannot be granted or revoked
56
+
* Only superusers and database owners can create new schemas
57
+
* Only superusers can create new roles
58
+
* Every role is granted the `CONNECT` privilege to the default database at creation (this privilege can be revoked)
59
+
* Every role is granted the `USAGE` privilege on the default `public` schema at creation (this privilege can be revoked)
60
+
* Oxla does not support role membership, so **privilege inheritance** is not available
61
+
62
+
[NOTE]
63
+
====
64
+
Once access control is enabled and Oxla Home is not empty, you cannot disable access control.
65
+
If you attempt to run Oxla with the access control flag in `OXLA_HOME` set to `OFF` after it was previously enabled,
66
+
Oxla will enter a <a href="/troubleshooting-optimization/degraded-state-handling" target="_blank">**degraded state**</a>.
0 commit comments