Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

prod #2237

Merged
merged 5 commits into from
May 23, 2024
Merged

prod #2237

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: 0 additions & 2 deletions packages/dolt/content/architecture/sql/go-mysql-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: Go MySQL Server
---

# Go MySQL Server

[go-mysql-server](https://github.com/dolthub/go-mysql-server) is the
query engine for Dolt. It's a MySQL compatible parser, server, and
query execution engine written in pure Go. As with Dolt, its goal is
Expand Down
2 changes: 0 additions & 2 deletions packages/dolt/content/architecture/sql/vitess.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: Vitess
---

# Vitess

Dolt's SQL server runs on [a fork of
Vitess](https://github.com/dolthub/vitess). Vitess is a MySQL database
sharding solution that was created to scale YouTube:
Expand Down
2 changes: 0 additions & 2 deletions packages/dolt/content/concepts/dolt/rdbms/replication.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: Replication
---

# Replication

## What is Replication?

Replication is the ability for an RDBMS to synchronize a primary server with one or more read replicas. In this configuration, the primary database serves reads and writes while the replicas only serve reads.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: Application Server
---

# Application Server

These instructions are for bootstrapping dolt as an application
database server. They assume you are starting from scratch on a Linux
machine without dolt installed or running.
Expand Down
11 changes: 5 additions & 6 deletions packages/dolt/content/other/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@
title: Versioning
---

# Versioning

Dolt uses a three digit versioning format – `major`.`minor`.`patch`. For major, minor, and patch version bumps, you can expect:
- **Patch version bumps** (e.g. `1.0.0` → `1.0.1`) – Patch version bumps will **NOT** change any interfaces; they include bug fixes, performance improvements, and additive features. You can safely pick up patch releases without having to update your application code.
- **Minor version bumps** (e.g. `1.0.0` → `1.1.0`) – Minor version bumps signal that the release contains an interface change, such as changing the signature of a Dolt CLI command or stored procedure. Your application code may require an update to move to a minor version bump if it is using an affected interface. Affected interfaces are called out in release notes.

- **Patch version bumps** (e.g. `1.0.0` → `1.0.1`) – Patch version bumps will **NOT** change any interfaces; they include bug fixes, performance improvements, and additive features. You can safely pick up patch releases without having to update your application code.
- **Minor version bumps** (e.g. `1.0.0` → `1.1.0`) – Minor version bumps signal that the release contains an interface change, such as changing the signature of a Dolt CLI command or stored procedure. Your application code may require an update to move to a minor version bump if it is using an affected interface. Affected interfaces are called out in release notes.
- **Major version bumps** (e.g. `1.0.0` → `2.0.0`) - Major version bumps signal a significant change that requires database data to be migrated, for example, [moving to a new low-level storage format](https://www.dolthub.com/blog/2022-11-01-dolthub-migrate-button/). Major version bumps will be extremely rare.

# Internal Feature Version

In addition to the external version number, Dolt also uses an internal "feature" version that is incremented when persisted data structures change in a backwards incompatible way. When you use a version of Dolt with a new feature version, once it writes data to your database, older clients with a lower feature version will no longer be able to read or write that database. You can check the feature version of your database by running `dolt version --feature` from within the database's directory.
In addition to the external version number, Dolt also uses an internal "feature" version that is incremented when persisted data structures change in a backwards incompatible way. When you use a version of Dolt with a new feature version, once it writes data to your database, older clients with a lower feature version will no longer be able to read or write that database. You can check the feature version of your database by running `dolt version --feature` from within the database's directory.

Feature version bumps will be called out in a version's release notes and will be released as a minor version bump. We avoid feature bumps as much as possible because they can be disruptive to customers, but they are occasionally needed when an existing data structure does not provide enough forward compatibility to support a new feature.
Feature version bumps will be called out in a version's release notes and will be released as a minor version bump. We avoid feature bumps as much as possible because they can be disruptive to customers, but they are occasionally needed when an existing data structure does not provide enough forward compatibility to support a new feature.
21 changes: 9 additions & 12 deletions packages/dolt/content/reference/cli/git-comparison.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ title: "Git Comparison"

We aim to match our CLI command behavior as closely to their Git equivalent as possible. This page lists the commands that are currently supported, and any known limitations.

# Git Comparison

## Setup and Config

| Component | Supported | Notes and limitations |
Expand Down Expand Up @@ -67,10 +65,10 @@ We aim to match our CLI command behavior as closely to their Git equivalent as p
## Patching

| Component | Supported | Notes and limitations |
| :------------ |:----------| :-------------------- |
| `cherry-pick` | ✅ | |
| `rebase` | ✅ | |
| `revert` | ✅ | |
| :------------ | :-------- | :-------------------- |
| `cherry-pick` | ✅ | |
| `rebase` | ✅ | |
| `revert` | ✅ | |

## Debugging

Expand All @@ -82,13 +80,12 @@ We aim to match our CLI command behavior as closely to their Git equivalent as p
## Administration

| Component | Supported | Notes and limitations |
|:----------------|:----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| :-------------- | :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `clean` | 🟠 | [does not completely match Git's behavior](https://github.com/dolthub/dolt/issues/6313) |
| `gc` | ✅ | |
| `fsck` | ❌ | |
| `reflog` | ✅ | [does not completely match Git's behavior](https://www.dolthub.com/blog/2023-11-17-dolt-reflog/):<br/> <li>only supports named references (not Git's special refs)</li> <li>shows deleted refs</li> |
| `filter-branch` | ✅ | |

| `gc` | ✅ | |
| `fsck` | ❌ | |
| `reflog` | ✅ | [does not completely match Git's behavior](https://www.dolthub.com/blog/2023-11-17-dolt-reflog/):<br/> <li>only supports named references (not Git's special refs)</li> <li>shows deleted refs</li> |
| `filter-branch` | ✅ | |

## Plumbing Commands

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions packages/doltgres/content/concepts/rdbms/replication.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: Replication
---

# Replication

## What is Replication?

Replication is the ability for an RDBMS to synchronize a primary server with one or more read
Expand Down
2 changes: 1 addition & 1 deletion packages/doltgres/content/introduction/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![](../../.gitbook/assets/doltgres-preview.png)
![](../.gitbook/assets/doltgres-preview.png)

DoltgreSQL, or Doltgres for short, is a Postgres-compatible version of [Dolt](https://www.doltdb.com). It is currently in [pre-alpha release](#doltgres-is-pre-alpha). Dolt is the world's first version controlled SQL database. It is like Git and MySQL had a baby. Doltgres is like Git and Postgres had a baby.

Expand Down
2 changes: 1 addition & 1 deletion packages/doltgres/content/reference/sql/server/backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ pushing to a remote can serve as a backup for some use cases.

### Configure a remote

This example uses DoltgresHub as a remote, but you can use Doltgres with [other remotes like
This example uses DoltHub as a remote, but you can use Doltgres with [other remotes like
filesystem, AWS S3, and GCS](https://www.dolthub.com/blog/2021-07-19-remotes/).

```sql
Expand Down
20 changes: 10 additions & 10 deletions packages/doltgres/content/reference/sql/server/replication.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ call dolt_commit('-Am', 'trigger replication');

After a `DOLT_COMMIT()`, changes are pushed to the configured remote.

![DoltgresHub Replication Example](../../../.gitbook/assets/replication-example.png)
![DoltHub Replication Example](../../../.gitbook/assets/replication-example.png)

#### Stopping Replication

Expand Down Expand Up @@ -184,7 +184,7 @@ You must restart the replica server for changes to take effect.
Now back on the primary:

```sql
insert into test values (2,2);
insert into test values (2,2);
call dolt_commit('-am', 'Inserted (2,2)');
+----------------------------------+
| hash |
Expand Down Expand Up @@ -224,7 +224,7 @@ Now I'm going to make a new branch on the primary and insert a new value on it.

```sql
call dolt_checkout('-b', 'branch1');
insert into test values (3,3);
insert into test values (3,3);
call dolt_commit('-am', 'Inserted (3,3)');
```

Expand Down Expand Up @@ -315,8 +315,8 @@ On `dolt-1.db`, we will have a `config.yaml` like:
```yaml
cluster:
standby_remotes:
- name: standby
remote_url_template: http://dolt-2.db:50051/{database}
- name: standby
remote_url_template: http://dolt-2.db:50051/{database}
bootstrap_role: primary
bootstrap_epoch: 1
remotesapi:
Expand All @@ -328,8 +328,8 @@ On `dolt-2.db`, we will have:
```yaml
cluster:
standby_remotes:
- name: standby
remote_url_template: http://dolt-1.db:50051/{database}
- name: standby
remote_url_template: http://dolt-1.db:50051/{database}
bootstrap_role: standby
bootstrap_epoch: 1
remotesapi:
Expand Down Expand Up @@ -660,9 +660,9 @@ things to consider when choosing how to configure replication.
files to a remote storage solution and having the read replica download the
files from there. On the other hand, direct replication may be less scalable in
the number of read replicas which it can gracefully handle, since the primary
itself is responsible for pushing each write to each standby server. For read
replicas, read latency for direct replication is always faster, since no
communication to a remote must take place. You can expect increased read latency
itself is responsible for pushing each write to each standby server. For read
replicas, read latency for direct replication is always faster, since no
communication to a remote must take place. You can expect increased read latency
on every transaction start of aremote-based read replica.

4. The ability to replicate writes with direct replication is not coupled with
Expand Down
6 changes: 3 additions & 3 deletions packages/doltlab/content/enterprise/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ ubuntu@ip-10-2-0-24:~/doltlab$ ./start.sh

Hit your DoltLab to make sure it works:

![](../../.gitbook/assets/doltlab-enterprise-works.png)
![](../.gitbook/assets/doltlab-enterprise-works.png)

You'll notice you have an Enterprise logo and the footer says "ENTERPRISE" in the version string. If you see those, your DoltLab Enterprise is working.

Expand All @@ -38,7 +38,7 @@ Most Enterprise features are enabled by [passing arguments to the installer](../

As some of you know, [DoltHub was initially Liquidata](https://www.dolthub.com/blog/2020-09-25-dolthub-rebrand/) and the logo was pretty sick.

![](../../.gitbook/assets/ld-logo.png)
![](../.gitbook/assets/ld-logo.png)

I'm going to make a DoltLab Enterprise instance that is Liquidata branded. Oh what could have been?

Expand All @@ -61,6 +61,6 @@ ubuntu@ip-10-2-0-24:~/doltlab$ ./installer --host=54.191.163.60 --enterprise-onl

Then I start my instance and I get a new look and feel.

![](../../.gitbook/assets/doltlab-custom-logo.png)
![](../.gitbook/assets/doltlab-custom-logo.png)

Again, most of the features are enabled using the installer, so get used to running that to change your running DoltLab.
Loading
Loading