Skip to content

Commit

Permalink
Create v24.3 paths (#18973)
Browse files Browse the repository at this point in the history
* Script output

* Add manual versions.csv updates

* Add new releases includes path, new alpha.1 include, updated releases.yml

* Add new version's release include path and alpha.1 file

* Create temporary anchors required to build

* Minor fixes to previous workarounds
  • Loading branch information
mikeCRL authored Oct 1, 2024
1 parent d6d8637 commit 1fdf714
Show file tree
Hide file tree
Showing 1,604 changed files with 157,294 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/current/_config_cockroachdb.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ destination: _site/docs
homepage_title: CockroachDB Docs
versions:
stable: v24.2
dev: v24.2
dev: v24.3
27 changes: 27 additions & 0 deletions src/current/_data/releases.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6807,3 +6807,30 @@
docker_arm_limited_access: false
source: true
previous_release: v23.2.11

- release_name: v24.3.0-alpha.1
major_version: v24.3
release_date: '2024-12-31'
release_type: Testing
go_version: go1.22.0
sha: 0123456789abcde0123456789abcde0123456789
has_sql_only: true
has_sha256sum: true
mac:
mac_arm: true
mac_arm_experimental: true
mac_arm_limited_access: false
windows: true
linux:
linux_arm: true
linux_arm_experimental: false
linux_arm_limited_access: false
linux_intel_fips: true
linux_arm_fips: false
docker:
docker_image: cockroachdb/cockroach-unstable
docker_arm: true
docker_arm_experimental: false
docker_arm_limited_access: false
source: true

1 change: 1 addition & 0 deletions src/current/_data/versions.csv
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ v23.1,2023-05-15,2024-05-15,2024-11-15,23.1.11,23.1.12,2023-11-13,2024-11-13,202
v23.2,2024-02-05,2025-02-05,2025-08-05,23.2.6,23.2.7,2024-07-08,2025-07-08,2026-07-08,v23.1,release-23.2
v24.1,2024-05-20,2025-05-20,2025-11-20,N/A,N/A,N/A,N/A,N/A,v23.2,release-24.1
v24.2,2024-08-12,2025-02-12,N/A,N/A,N/A,N/A,N/A,N/A,v24.1,release-24.2
v24.3,2024-12-25,2025-06-25,N/A,N/A,N/A,N/A,N/A,N/A,v24.2,master
3 changes: 3 additions & 0 deletions src/current/_includes/releases/v24.3/v24.3.0-alpha.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## v24.3.0-alpha.1

Release Date: TBD
26 changes: 26 additions & 0 deletions src/current/_includes/sidebar-data-v24.3.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
[
{
"title": "Docs Home",
"is_top_level": true,
"urls": [
"/"
]
},
{% include_cached v24.3/sidebar-data/get-started.json %},
{% include_cached v24.3/sidebar-data/releases.json %},
{% include_cached v24.3/sidebar-data/feature-overview.json %},
{% include_cached v24.3/sidebar-data/connect-to-cockroachdb.json %},
{% include_cached v24.3/sidebar-data/migrate.json %},
{% include_cached v24.3/sidebar-data/cloud-deployments.json %},
{% include_cached v24.3/sidebar-data/self-hosted-deployments.json %},
{% include_cached v24.3/sidebar-data/schema-design.json %},
{% include_cached v24.3/sidebar-data/reads-and-writes.json %},
{% include_cached v24.3/sidebar-data/stream-data.json %},
{% include_cached v24.3/sidebar-data/multi-region-capabilities.json %},
{% include_cached v24.3/sidebar-data/optimize-performance.json %},
{% include_cached v24.3/sidebar-data/troubleshooting.json %},
{% include_cached v24.3/sidebar-data/sql.json %},
{% include_cached v24.3/sidebar-data/reference.json %},
{% include_cached v24.3/sidebar-data/faqs.json %},
{% include_cached sidebar-data-cockroach-university.json %}
]
12 changes: 12 additions & 0 deletions src/current/_includes/v24.3/app/before-you-begin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
1. [Install CockroachDB]({% link {{ page.version.version }}/install-cockroachdb.md %}).
1. Start up a [secure]({% link {{ page.version.version }}/secure-a-cluster.md %}) or [insecure]({% link {{ page.version.version }}/start-a-local-cluster.md %}) local cluster.
1. Choose the instructions that correspond to whether your cluster is secure or insecure:

<div class="filters filters-big clearfix">
<button class="filter-button" data-scope="secure">Secure</button>
<button class="filter-button" data-scope="insecure">Insecure</button>
</div>

<section class="filter-content" markdown="1" data-scope="insecure">
{% include {{ page.version.version }}/prod-deployment/insecure-flag.md %}
</section>
10 changes: 10 additions & 0 deletions src/current/_includes/v24.3/app/cc-free-tier-params.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Where:

- `{username}` and `{password}` specify the SQL username and password that you created earlier.
- `{globalhost}` is the name of the CockroachDB {{ site.data.products.cloud }} free tier host (e.g., `free-tier.gcp-us-central1.cockroachlabs.cloud`).
- `{path to the CA certificate}` is the path to the `cc-ca.crt` file that you downloaded from the CockroachDB {{ site.data.products.cloud }} Console.
- `{cluster_name}` is the name of your cluster.

{{site.data.alerts.callout_info}}
If you are using the connection string that you [copied from the **Connection info** modal](#set-up-your-cluster-connection), your username, password, hostname, and cluster name will be pre-populated.
{{site.data.alerts.end}}
54 changes: 54 additions & 0 deletions src/current/_includes/v24.3/app/create-a-database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<section class="filter-content" markdown="1" data-scope="local">

1. In the SQL shell, create the `bank` database that your application will use:

{% include_cached copy-clipboard.html %}
~~~ sql
> CREATE DATABASE bank;
~~~

1. Create a SQL user for your app:

{% include_cached copy-clipboard.html %}
~~~ sql
> CREATE USER <username> WITH PASSWORD <password>;
~~~

Take note of the username and password. You will use it in your application code later.

1. Give the user the necessary permissions:

{% include_cached copy-clipboard.html %}
~~~ sql
> GRANT ALL ON DATABASE bank TO <username>;
~~~

</section>

<section class="filter-content" markdown="1" data-scope="cockroachcloud">

1. If you haven't already, [download the CockroachDB binary]({% link {{ page.version.version }}/install-cockroachdb.md %}).
1. Start the [built-in SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}) using the connection string you got from the CockroachDB {{ site.data.products.cloud }} Console:
{% include_cached copy-clipboard.html %}
~~~ shell
$ cockroach sql \
--url='<connection-string>'
~~~
1. In the SQL shell, create the `bank` database that your application will use:
{% include_cached copy-clipboard.html %}
~~~ sql
> CREATE DATABASE bank;
~~~
1. Exit the SQL shell:
{% include_cached copy-clipboard.html %}
~~~ sql
> \q
~~~
</section>
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Start the [built-in SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}):

{% include_cached copy-clipboard.html %}
~~~ shell
$ cockroach sql --certs-dir=certs
~~~

In the SQL shell, issue the following statements to create the `maxroach` user and `bank` database:

{% include_cached copy-clipboard.html %}
~~~ sql
> CREATE USER IF NOT EXISTS maxroach;
~~~

{% include_cached copy-clipboard.html %}
~~~ sql
> CREATE DATABASE bank;
~~~

Give the `maxroach` user the necessary permissions:

{% include_cached copy-clipboard.html %}
~~~ sql
> GRANT ALL ON DATABASE bank TO maxroach;
~~~

Exit the SQL shell:

{% include_cached copy-clipboard.html %}
~~~ sql
> \q
~~~
4 changes: 4 additions & 0 deletions src/current/_includes/v24.3/app/for-a-complete-example-go.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
For complete examples, see:

- [Build a Go App with CockroachDB]({% link {{ page.version.version }}/build-a-go-app-with-cockroachdb.md %}) (pgx)
- [Build a Go App with CockroachDB and GORM]({% link {{ page.version.version }}/build-a-go-app-with-cockroachdb.md %})
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
For complete examples, see:

- [Build a Java App with CockroachDB]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb.md %}) (JDBC)
- [Build a Java App with CockroachDB and Hibernate]({% link {{ page.version.version }}/build-a-java-app-with-cockroachdb-hibernate.md %})
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
For complete examples, see:

- [Build a Python App with CockroachDB]({% link {{ page.version.version }}/build-a-python-app-with-cockroachdb-psycopg3.md %}) (psycopg3)
- [Build a Python App with CockroachDB and SQLAlchemy]({% link {{ page.version.version }}/build-a-python-app-with-cockroachdb-sqlalchemy.md %})
- [Build a Python App with CockroachDB and Django]({% link {{ page.version.version }}/build-a-python-app-with-cockroachdb-django.md %})
- [Build a Python App with CockroachDB and asyncpg]({% link {{ page.version.version }}/build-a-python-app-with-cockroachdb-asyncpg.md %})
5 changes: 5 additions & 0 deletions src/current/_includes/v24.3/app/hibernate-dialects-note.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Versions of the Hibernate CockroachDB dialect correspond to the version of CockroachDB installed on your machine. For example, `org.hibernate.dialect.CockroachDB201Dialect` corresponds to CockroachDB v20.1 and later, and `org.hibernate.dialect.CockroachDB192Dialect` corresponds to CockroachDB v19.2 and later.

All dialect versions are forward-compatible (e.g., CockroachDB v20.1 is compatible with `CockroachDB192Dialect`), as long as your application is not affected by any backward-incompatible changes listed in your CockroachDB version's [release notes]({% link releases/index.md %}). In the event of a CockroachDB version upgrade, using a previous version of the CockroachDB dialect will not break an application, but, to enable all features available in your version of CockroachDB, we recommend keeping the dialect version in sync with the installed version of CockroachDB.

Not all versions of CockroachDB have a corresponding dialect yet. Use the dialect number that is closest to your installed version of CockroachDB. For example, use `CockroachDB201Dialect` when using CockroachDB v21.1 and later.
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Start the [built-in SQL shell]({% link {{ page.version.version }}/cockroach-sql.md %}):

{% include_cached copy-clipboard.html %}
~~~ shell
$ cockroach sql --insecure
~~~

In the SQL shell, issue the following statements to create the `maxroach` user and `bank` database:

{% include_cached copy-clipboard.html %}
~~~ sql
> CREATE USER IF NOT EXISTS maxroach;
~~~

{% include_cached copy-clipboard.html %}
~~~ sql
> CREATE DATABASE bank;
~~~

Give the `maxroach` user the necessary permissions:

{% include_cached copy-clipboard.html %}
~~~ sql
> GRANT ALL ON DATABASE bank TO maxroach;
~~~

Exit the SQL shell:

{% include_cached copy-clipboard.html %}
~~~ sql
> \q
~~~
Loading

0 comments on commit 1fdf714

Please sign in to comment.