Skip to content

Commit

Permalink
doc/user: convert release notes to use mzsql highlighting where appro…
Browse files Browse the repository at this point in the history
…priate
  • Loading branch information
arusahni committed Jun 21, 2024
1 parent 8ff0827 commit 2756b65
Show file tree
Hide file tree
Showing 40 changed files with 72 additions and 72 deletions.
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.100.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ patch: 1
* Add a [`MAP` expression](/sql/types/map/#construction) that allows constructing a `map`
from a list of key–value pairs or a subquery.

```sql
```mzsql
SELECT MAP['a' => 1, 'b' => 2];
map
Expand Down
20 changes: 10 additions & 10 deletions doc/user/content/releases/v0.27.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ substantial breaking changes from [v0.26 LTS].
To emulate the old behavior, explicitly create a default index after creating
a view:

```sql
```mzsql
CREATE VIEW <name> ...;
CREATE DEFAULT INDEX ON <name>;
```
Expand All @@ -84,7 +84,7 @@ substantial breaking changes from [v0.26 LTS].
a default index. Instead, you must explicitly create a default index after
creating a source:

```sql
```mzsql
CREATE SOURCE <name> ...;
CREATE DEFAULT INDEX ON <name>;
```
Expand Down Expand Up @@ -141,7 +141,7 @@ from Materialize v0.26 LTS for Materialize v0.27:

Change from:

```sql
```mzsql
CREATE SOURCE kafka_sasl
FROM KAFKA BROKER 'broker.tld:9092' TOPIC 'top-secret' WITH (
security_protocol = 'SASL_SSL',
Expand All @@ -157,7 +157,7 @@ CREATE SOURCE kafka_sasl

to:

```sql
```mzsql
CREATE SECRET kafka_password AS '<BROKER_PASSWORD>';
CREATE SECRET csr_password AS '<SCHEMA_REGISTRY_PASSWORD>';
Expand All @@ -182,13 +182,13 @@ CREATE SOURCE kafka_top_secret

Change from:

```sql
```mzsql
CREATE MATERIALIZED VIEW v AS SELECT ...
```

to:

```sql
```mzsql
CREATE VIEW v AS SELECT ...
CREATE DEFAULT INDEX ON v
```
Expand All @@ -197,13 +197,13 @@ CREATE DEFAULT INDEX ON v

Change from:

```sql
```mzsql
CREATE MATERIALIZED SOURCE src ...
```

to:

```sql
```mzsql
CREATE SOURCE src ...
```

Expand All @@ -218,13 +218,13 @@ CREATE INDEX on src (lookup_col1, lookup_col2)

Change from:

```sql
```mzsql
COPY (TAIL t) TO STDOUT
```

to:

```sql
```mzsql
COPY (SUBSCRIBE t) TO STDOUT
```

Expand Down
6 changes: 3 additions & 3 deletions doc/user/content/releases/v0.28.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ aliases: v0.28.0

**New syntax**

```sql
```mzsql
CREATE CONNECTION kafka_connection TO KAFKA (
BROKER 'unique-jellyfish-0000-kafka.upstash.io:9092',
SASL MECHANISMS = 'SCRAM-SHA-256',
Expand All @@ -29,7 +29,7 @@ aliases: v0.28.0

**Old syntax**

```sql
```mzsql
CREATE CONNECTION kafka_connection FOR KAFKA
BROKER 'unique-jellyfish-0000-kafka.upstash.io:9092',
SASL MECHANISMS = 'SCRAM-SHA-256',
Expand All @@ -56,7 +56,7 @@ aliases: v0.28.0
cluster. For the best performance when executing `SHOW` commands, switch to
the `mz_introspection` cluster using:

```sql
```mzsql
SET CLUSTER = mz_introspection;
```

Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.29.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ patch: 3
to literal values, particularly in cases where e.g. `col_a` was of type
`VARCHAR`:

```sql
```mzsql
SELECT * FROM table_foo WHERE col_a = 'hello';
```

Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.30.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ patch: 2
[PostgreSQL source](/sql/create-source/postgres/), specifying the table and
column containing an unsupported type:

```sql
```mzsql
CREATE SOURCE pg_source
FROM POSTGRES CONNECTION pg_connection (PUBLICATION 'mz_source')
FOR ALL TABLES
Expand Down
4 changes: 2 additions & 2 deletions doc/user/content/releases/v0.32.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ patch: 4
[PostgreSQL source](/sql/create-source/postgres/), using the new `TEXT
COLUMNS` option:

```sql
```mzsql
CREATE SOURCE mz_source
FROM POSTGRES CONNECTION pg_connection (
PUBLICATION 'mz_source',
Expand All @@ -28,7 +28,7 @@ patch: 4
* Improve error message for unexpected or mismatched type catalog errors,
specifying the catalog item type:

```sql
```mzsql
DROP VIEW mz_table;
ERROR: "materialize.public.mz_table" is a table not a view
Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.33.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ patch: 3
to an SSH bastion server.


```sql
```mzsql
CREATE CONNECTION kafka_connection TO KAFKA (
BROKERS (
'broker1:9092' USING SSH TUNNEL ssh_connection,
Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.36.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ patch: 2
all extant cluster replicas as a % of the total allocation, you can now
use:

```sql
```mzsql
SELECT
r.id AS replica_id,
m.process_id,
Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.37.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ patch: 3
to the system catalog. This view allows you to monitor the resource utilization for
all extant cluster replicas as a % of the total resource allocation:

```sql
```mzsql
SELECT * FROM mz_internal.mz_cluster_replica_utilization;
```

Expand Down
4 changes: 2 additions & 2 deletions doc/user/content/releases/v0.39.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ patch: 3
example, you can now get an overview of the relationship between user-defined
objects using:

```sql
```mzsql
SELECT
object_id,
o.name,
Expand All @@ -41,7 +41,7 @@ patch: 3
the value returned by the existing `mz_version()` function, but the parameter
form can be more convenient for downstream applications.

```sql
```mzsql
SHOW mz_version;
```

Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.40.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ released: true
* Allow configuring an `AVAILABILITY ZONE` option for each broker when creating
a Kafka connection using [AWS PrivateLink](/sql/create-connection/#kafka-network-security):

```sql
```mzsql
CREATE CONNECTION privatelink_svc TO AWS PRIVATELINK (
SERVICE NAME 'com.amazonaws.vpce.us-east-1.vpce-svc-0e123abc123198abc',
AVAILABILITY ZONES ('use1-az1', 'use1-az4')
Expand Down
4 changes: 2 additions & 2 deletions doc/user/content/releases/v0.41.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ patch: 1
name of the replication slot created in the upstream PostgreSQL
database that Materialize will create for each source.

```sql
```mzsql
SELECT * FROM mz_internal.mz_postgres_sources;
id | replication_slot
Expand All @@ -32,7 +32,7 @@ patch: 1

**New syntax**

```sql
```mzsql
CREATE SOURCE kafka_connection
IN CLUSTER quickstart
FROM KAFKA CONNECTION qck_kafka_connection (TOPIC 'test_topic')
Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.43.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ released: true
PHYSICAL PLAN FOR [MATERIALIZED] VIEW $view_name` to print the name of the
view. The output will now look similar to:

```sql
```mzsql
EXPLAIN VIEW v;
Optimized Plan
Expand Down
6 changes: 3 additions & 3 deletions doc/user/content/releases/v0.45.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ released: true

**Example**

```sql
```mzsql
-- Given a "purchases" Kafka source, a "purchases_progress"
-- subsource is automatically created
SELECT partition, "offset"
Expand Down Expand Up @@ -48,7 +48,7 @@ released: true
* Support `options` settings on connection startup. As an example, you can
now specify the cluster to connect to in the `psql` connection string:

```sql
```mzsql
psql "postgres://user%40domain.com@host:6875/materialize?options=--cluster%3Dfoo"
```

Expand All @@ -74,7 +74,7 @@ now specify the cluster to connect to in the `psql` connection string:

**Example**

```sql
```mzsql
CREATE VIEW foo AS SELECT 'bar';
ERROR: view "materialize.public.foo" already exists
Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.48.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ patch: 4
* Support specifying multiple roles in the [`GRANT ROLE`](/sql/grant-role) and
[`REVOKE ROLE`](/sql/revoke-role) commands.

```sql
```mzsql
-- Grant role
GRANT data_scientist TO joe, mike;
Expand Down
4 changes: 2 additions & 2 deletions doc/user/content/releases/v0.51.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ patch: 1
[PostgreSQL source](/sql/create-source/postgres/), using the new `FOR SCHEMAS(...)`
option:

```sql
```mzsql
CREATE SOURCE mz_source
FROM POSTGRES CONNECTION pg_connection (PUBLICATION 'mz_source')
FOR SCHEMAS (public, finance)
Expand All @@ -33,7 +33,7 @@ patch: 1
replaces a set of characters in a string with another set of characters
(one by one, regardless of the order of those characters):

```sql
```mzsql
SELECT translate('12345', '134', 'ax');
translate
Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.52.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ mentioning it here."
To see your current credit consumption rate, measured in credits per hour, run
the following query:

```sql
```mzsql
SELECT sum(s.credits_per_hour) AS credit_consumption_rate
FROM mz_cluster_replicas r
JOIN mz_internal.mz_cluster_replica_sizes s ON r.size = s.size;
Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.53.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ released: true
join condition in the statement below will be referenceable as `lhs.c`,
`rhs.c`, and `joint.c`.

```sql
```mzsql
SELECT *
FROM lhs
JOIN rhs USING (c) AS joint;
Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.54.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ released: true
roles, as well as the `ALL` keyword to indicate that all privileges should
be granted or revoked.

```sql
```mzsql
GRANT SELECT ON mv TO joe, mike;
GRANT ALL ON CLUSTER dev TO joe;
Expand Down
4 changes: 2 additions & 2 deletions doc/user/content/releases/v0.55.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ patch: 6
current_schema`, respectively. From this release, the following sequence of
commands provide the same functionality:

```sql
```mzsql
materialize=> SET schema = finance;
SET
materialize=> SHOW schema;
Expand All @@ -23,7 +23,7 @@ patch: 6
(1 row)
```

```sql
```mzsql
materialize=> SET search_path = finance, public;
SET
materialize=> SELECT current_schema;
Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.56.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ patch: 4
* Add the `has_table_privilege` access control function, which allows a role
to query if it has privileges on a specific relation:

```sql
```mzsql
SELECT has_table_privilege('marta','auction_house','select');
has_table_privilege
Expand Down
4 changes: 2 additions & 2 deletions doc/user/content/releases/v0.57.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ patch: 10
* Add `RESET schema` as an alias to `RESET search_path`. From this release, the
following sequence of commands provide the same functionality:

```sql
```mzsql
materialize=> SET schema = finance;
SET
materialize=> SHOW schema;
Expand All @@ -41,7 +41,7 @@ patch: 10
(1 row)
```

```sql
```mzsql
materialize=> SET search_path = finance, public;
SET
materialize=> SELECT current_schema;
Expand Down
2 changes: 1 addition & 1 deletion doc/user/content/releases/v0.59.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ supported in the next release.

* Support parsing multi-dimensional arrays, including multi-dimensional empty arrays.

```sql
```mzsql
materialize=> SELECT '{{1}, {2}}'::int[];
arr
-----------
Expand Down
4 changes: 2 additions & 2 deletions doc/user/content/releases/v0.60.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ flag. The flag was raised in v0.60 -— so mentioning it here."

**New syntax**

```sql
```mzsql
CREATE SOURCE json_source
FROM KAFKA CONNECTION kafka_connection (TOPIC 'ch_anges')
FORMAT JSON
Expand All @@ -39,7 +39,7 @@ flag. The flag was raised in v0.60 -— so mentioning it here."

**Old syntax**

```sql
```mzsql
CREATE SOURCE json_source
FROM KAFKA CONNECTION kafka_connection (TOPIC 'ch_anges')
FORMAT BYTES
Expand Down
Loading

0 comments on commit 2756b65

Please sign in to comment.