-
Notifications
You must be signed in to change notification settings - Fork 468
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 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
Showing
1,604 changed files
with
157,294 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,4 +4,4 @@ destination: _site/docs | |
homepage_title: CockroachDB Docs | ||
versions: | ||
stable: v24.2 | ||
dev: v24.2 | ||
dev: v24.3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## v24.3.0-alpha.1 | ||
|
||
Release Date: TBD |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %} | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
32 changes: 32 additions & 0 deletions
32
src/current/_includes/v24.3/app/create-maxroach-user-and-bank-database.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
~~~ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %}) |
4 changes: 4 additions & 0 deletions
4
src/current/_includes/v24.3/app/for-a-complete-example-java.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %}) |
6 changes: 6 additions & 0 deletions
6
src/current/_includes/v24.3/app/for-a-complete-example-python.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 %}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
32 changes: 32 additions & 0 deletions
32
src/current/_includes/v24.3/app/insecure/create-maxroach-user-and-bank-database.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
~~~ |
Oops, something went wrong.