From be98b9f9c766e98d6034b55fd16a2d86e3324d84 Mon Sep 17 00:00:00 2001 From: Alexey Palazhchenko Date: Mon, 19 Feb 2024 15:58:51 +0400 Subject: [PATCH] Prepare v1.20.0 release --- CHANGELOG.md | 41 ++++++++++++- website/docusaurus.config.js | 2 +- .../aggregation-operations/_category_.yml | 0 .../aggregation-pipeline-and-commands.md | 0 .../aggregation-stages.md | 0 .../basic-operations/_category_.yml | 0 .../basic-operations/create.md | 0 .../basic-operations/delete.md | 0 .../basic-operations/performing.md | 0 .../basic-operations/read.md | 0 .../basic-operations/update.md | 0 .../configuration/_category_.yml | 0 .../configuration/flags.md | 15 ++--- .../configuration/observability.md | 0 .../configuration/operation-modes.md | 0 .../configuration/oplog-support.md | 57 +++++++++++++++++++ .../contributing/_category_.yml | 0 .../contributing/how-to-contribute.md | 0 .../contributing/writing-guide.md | 0 .../{version-v1.17 => version-v1.20}/diff.md | 0 .../indexes.md | 0 .../{version-v1.17 => version-v1.20}/main.md | 0 .../migration/_category_.yml | 0 .../migration/migrating-from-mongodb.md | 0 .../migration/premigration-testing.md | 0 .../operators/_category_.yml | 0 .../operators/query/_category_.yml | 0 .../operators/query/array-operators.md | 0 .../operators/query/bitwise-operators.md | 0 .../operators/query/comparison-operators.md | 0 .../operators/query/element-operators.md | 0 .../operators/query/evaluation-operators.md | 0 .../operators/query/logical-operators.md | 0 .../operators/update/_category_.yml | 0 .../update/array-update-operators.md | 0 .../update/field-update-operators.md | 0 .../pushdown.md | 0 .../quickstart-guide/_category_.yml | 0 .../quickstart-guide/deb.md | 0 .../quickstart-guide/docker.md | 0 .../quickstart-guide/go.md | 0 .../quickstart-guide/macos.md | 0 .../quickstart-guide/rpm.md | 0 .../quickstart-guide/windows.md | 0 .../reference/_category_.yml | 0 .../reference/glossary.md | 0 .../reference/supported-commands.md | 26 +++++---- .../security/_category_.yml | 0 .../security/authentication.md | 0 .../security/tls-connections.md | 0 .../telemetry.md | 2 +- .../understanding-ferretdb.md | 0 ...ebars.json => version-v1.20-sidebars.json} | 0 website/versions.json | 4 +- 54 files changed, 125 insertions(+), 22 deletions(-) rename website/versioned_docs/{version-v1.17 => version-v1.20}/aggregation-operations/_category_.yml (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/aggregation-operations/aggregation-pipeline-and-commands.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/aggregation-operations/aggregation-stages.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/basic-operations/_category_.yml (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/basic-operations/create.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/basic-operations/delete.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/basic-operations/performing.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/basic-operations/read.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/basic-operations/update.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/configuration/_category_.yml (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/configuration/flags.md (84%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/configuration/observability.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/configuration/operation-modes.md (100%) create mode 100644 website/versioned_docs/version-v1.20/configuration/oplog-support.md rename website/versioned_docs/{version-v1.17 => version-v1.20}/contributing/_category_.yml (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/contributing/how-to-contribute.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/contributing/writing-guide.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/diff.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/indexes.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/main.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/migration/_category_.yml (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/migration/migrating-from-mongodb.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/migration/premigration-testing.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/operators/_category_.yml (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/operators/query/_category_.yml (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/operators/query/array-operators.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/operators/query/bitwise-operators.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/operators/query/comparison-operators.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/operators/query/element-operators.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/operators/query/evaluation-operators.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/operators/query/logical-operators.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/operators/update/_category_.yml (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/operators/update/array-update-operators.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/operators/update/field-update-operators.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/pushdown.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/quickstart-guide/_category_.yml (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/quickstart-guide/deb.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/quickstart-guide/docker.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/quickstart-guide/go.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/quickstart-guide/macos.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/quickstart-guide/rpm.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/quickstart-guide/windows.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/reference/_category_.yml (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/reference/glossary.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/reference/supported-commands.md (98%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/security/_category_.yml (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/security/authentication.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/security/tls-connections.md (100%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/telemetry.md (99%) rename website/versioned_docs/{version-v1.17 => version-v1.20}/understanding-ferretdb.md (100%) rename website/versioned_sidebars/{version-v1.17-sidebars.json => version-v1.20-sidebars.json} (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index b9d9c7d317eb..797770474e99 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ -## v1.20.0 (not released yet) +## [v1.20.0](https://github.com/FerretDB/FerretDB/releases/tag/v1.20.0) (2024-02-19) ### What's Changed @@ -10,6 +10,45 @@ Production Docker images now use a non-root user with UID 1000 and GID 1000. +### Documentation 📄 + +- Add blog post on Ubicloud managed postgres by @Fashander in https://github.com/FerretDB/FerretDB/pull/4010 +- Add release blog post for v1.19.0 by @Fashander in https://github.com/FerretDB/FerretDB/pull/4020 +- Truncate release blog post by @Fashander in https://github.com/FerretDB/FerretDB/pull/4047 +- Add blog post on Disaster Recovery for FerretDB with Elotl Nova by @Fashander in https://github.com/FerretDB/FerretDB/pull/4038 +- Update Codapi by @Fashander in https://github.com/FerretDB/FerretDB/pull/4039 +- Add blogpost on FerretDB stack on Tembo by @Fashander in https://github.com/FerretDB/FerretDB/pull/4037 + +### Other Changes 🤖 + +- Add tests for new SCRAM-SHA-256 authentication support by @henvic in https://github.com/FerretDB/FerretDB/pull/4012 +- Add `TODO` comments for logging by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4015 +- Add `bson2` helpers for conversions and logging by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4019 +- Setup MySQL backend by @adetunjii in https://github.com/FerretDB/FerretDB/pull/4003 +- Expose new authentication enabling flag by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4029 +- Bump deps and speed-up `checkcomments` by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4030 +- Display `envtool run test` progress with run and/or skip flags by @fadyat in https://github.com/FerretDB/FerretDB/pull/3999 +- Use Ubicloud for CI runners by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4027 +- Implement `database.Stats` for MySQL backend by @adetunjii in https://github.com/FerretDB/FerretDB/pull/4034 +- Minor cleanups by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4046 +- Add experimental pushdown for dot notation by @noisersup in https://github.com/FerretDB/FerretDB/pull/4049 +- Bump Go to 1.21.7 by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4059 +- Add utility for hashing SCRAM-SHA-256 password by @henvic in https://github.com/FerretDB/FerretDB/pull/4031 +- Use rootless `scratch` containers for production Docker images by @ahmethakanbesel in https://github.com/FerretDB/FerretDB/pull/4004 +- Prepare query statements for MySQL by @adetunjii in https://github.com/FerretDB/FerretDB/pull/4064 +- Implement `bson2.RawDocument` checking by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4076 +- Add helper for decoding document sequences by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4080 +- Add SCRAM-SHA-256 authentication support by @henvic in https://github.com/FerretDB/FerretDB/pull/3989 +- Remove SCRAM-SHA-256 implementation TODO links by @henvic in https://github.com/FerretDB/FerretDB/pull/4086 +- Update telemetry host by @AlekSi in https://github.com/FerretDB/FerretDB/pull/4085 + +### New Contributors + +- @ahmethakanbesel made their first contribution in https://github.com/FerretDB/FerretDB/pull/4004 + +[All closed issues and pull requests](https://github.com/FerretDB/FerretDB/milestone/62?closed=1). +[All commits](https://github.com/FerretDB/FerretDB/compare/v1.19.0...v1.20.0). + ## [v1.19.0](https://github.com/FerretDB/FerretDB/releases/tag/v1.19.0) (2024-01-29) ### New Features 🎉 diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 5d6b29d49139..04e930bee90a 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -49,7 +49,7 @@ const config = { versions: { // the latest minus one minor - 'v1.18': { + 'v1.19': { banner: 'none', }, }, diff --git a/website/versioned_docs/version-v1.17/aggregation-operations/_category_.yml b/website/versioned_docs/version-v1.20/aggregation-operations/_category_.yml similarity index 100% rename from website/versioned_docs/version-v1.17/aggregation-operations/_category_.yml rename to website/versioned_docs/version-v1.20/aggregation-operations/_category_.yml diff --git a/website/versioned_docs/version-v1.17/aggregation-operations/aggregation-pipeline-and-commands.md b/website/versioned_docs/version-v1.20/aggregation-operations/aggregation-pipeline-and-commands.md similarity index 100% rename from website/versioned_docs/version-v1.17/aggregation-operations/aggregation-pipeline-and-commands.md rename to website/versioned_docs/version-v1.20/aggregation-operations/aggregation-pipeline-and-commands.md diff --git a/website/versioned_docs/version-v1.17/aggregation-operations/aggregation-stages.md b/website/versioned_docs/version-v1.20/aggregation-operations/aggregation-stages.md similarity index 100% rename from website/versioned_docs/version-v1.17/aggregation-operations/aggregation-stages.md rename to website/versioned_docs/version-v1.20/aggregation-operations/aggregation-stages.md diff --git a/website/versioned_docs/version-v1.17/basic-operations/_category_.yml b/website/versioned_docs/version-v1.20/basic-operations/_category_.yml similarity index 100% rename from website/versioned_docs/version-v1.17/basic-operations/_category_.yml rename to website/versioned_docs/version-v1.20/basic-operations/_category_.yml diff --git a/website/versioned_docs/version-v1.17/basic-operations/create.md b/website/versioned_docs/version-v1.20/basic-operations/create.md similarity index 100% rename from website/versioned_docs/version-v1.17/basic-operations/create.md rename to website/versioned_docs/version-v1.20/basic-operations/create.md diff --git a/website/versioned_docs/version-v1.17/basic-operations/delete.md b/website/versioned_docs/version-v1.20/basic-operations/delete.md similarity index 100% rename from website/versioned_docs/version-v1.17/basic-operations/delete.md rename to website/versioned_docs/version-v1.20/basic-operations/delete.md diff --git a/website/versioned_docs/version-v1.17/basic-operations/performing.md b/website/versioned_docs/version-v1.20/basic-operations/performing.md similarity index 100% rename from website/versioned_docs/version-v1.17/basic-operations/performing.md rename to website/versioned_docs/version-v1.20/basic-operations/performing.md diff --git a/website/versioned_docs/version-v1.17/basic-operations/read.md b/website/versioned_docs/version-v1.20/basic-operations/read.md similarity index 100% rename from website/versioned_docs/version-v1.17/basic-operations/read.md rename to website/versioned_docs/version-v1.20/basic-operations/read.md diff --git a/website/versioned_docs/version-v1.17/basic-operations/update.md b/website/versioned_docs/version-v1.20/basic-operations/update.md similarity index 100% rename from website/versioned_docs/version-v1.17/basic-operations/update.md rename to website/versioned_docs/version-v1.20/basic-operations/update.md diff --git a/website/versioned_docs/version-v1.17/configuration/_category_.yml b/website/versioned_docs/version-v1.20/configuration/_category_.yml similarity index 100% rename from website/versioned_docs/version-v1.17/configuration/_category_.yml rename to website/versioned_docs/version-v1.20/configuration/_category_.yml diff --git a/website/versioned_docs/version-v1.17/configuration/flags.md b/website/versioned_docs/version-v1.20/configuration/flags.md similarity index 84% rename from website/versioned_docs/version-v1.17/configuration/flags.md rename to website/versioned_docs/version-v1.20/configuration/flags.md index aaaca18df10d..b9991c2f4768 100644 --- a/website/versioned_docs/version-v1.17/configuration/flags.md +++ b/website/versioned_docs/version-v1.20/configuration/flags.md @@ -21,13 +21,14 @@ Some default values are overridden in [our Docker image](../quickstart-guide/doc ## General -| Flag | Description | Environment Variable | Default Value | -| -------------- | ----------------------------------------------------------------- | -------------------- | ------------------------------ | -| `-h`, `--help` | Show context-sensitive help | | false | -| `--version` | Print version to stdout and exit | | false | -| `--handler` | Backend handler | `FERRETDB_HANDLER` | `pg` (PostgreSQL) | -| `--mode` | [Operation mode](operation-modes.md) | `FERRETDB_MODE` | `normal` | -| `--state-dir` | Path to the FerretDB state directory
(set to `-` to disable) | `FERRETDB_STATE_DIR` | `.`
(`/state` for Docker) | +| Flag | Description | Environment Variable | Default Value | +| ----------------- | ----------------------------------------------------------------- | ------------------------ | ------------------------------ | +| `-h`, `--help` | Show context-sensitive help | | false | +| `--version` | Print version to stdout and exit | | false | +| `--handler` | Backend handler | `FERRETDB_HANDLER` | `pg` (PostgreSQL) | +| `--mode` | [Operation mode](operation-modes.md) | `FERRETDB_MODE` | `normal` | +| `--state-dir` | Path to the FerretDB state directory
(set to `-` to disable) | `FERRETDB_STATE_DIR` | `.`
(`/state` for Docker) | +| `--repl-set-name` | Replica set name
(should be set for OpLog to work correctly) | `FERRETDB_REPL_SET_NAME` | empty | ## Interfaces diff --git a/website/versioned_docs/version-v1.17/configuration/observability.md b/website/versioned_docs/version-v1.20/configuration/observability.md similarity index 100% rename from website/versioned_docs/version-v1.17/configuration/observability.md rename to website/versioned_docs/version-v1.20/configuration/observability.md diff --git a/website/versioned_docs/version-v1.17/configuration/operation-modes.md b/website/versioned_docs/version-v1.20/configuration/operation-modes.md similarity index 100% rename from website/versioned_docs/version-v1.17/configuration/operation-modes.md rename to website/versioned_docs/version-v1.20/configuration/operation-modes.md diff --git a/website/versioned_docs/version-v1.20/configuration/oplog-support.md b/website/versioned_docs/version-v1.20/configuration/oplog-support.md new file mode 100644 index 000000000000..4d43c5b3591d --- /dev/null +++ b/website/versioned_docs/version-v1.20/configuration/oplog-support.md @@ -0,0 +1,57 @@ +--- +sidebar_position: 4 +slug: /configuration/oplog-support/ +--- + +# OpLog support + +FerretDB currently has a basic implementation of the OpLog (operations log). + +The OpLog is a special capped collection which stores all operations that modify your data. +A capped collection is a fixed-sized collection that overwrites its entries when it reaches its maximum size. +Naturally, OpLog is a capped collection so as to ensure that data does not grow unbounded. + +:::note +At the moment, only basic OpLog tailing is supported. +Replication is not supported yet. +::: + +Oplog support is critical for the Meteor framework to build real-time applications. +Such applications require notifications on real-time events and can use the OpLog to build a simple pub/sub system. + +## Enabling OpLog functionality + +FerretDB will not create the oplog automatically; you must do so manually. + +To enable OpLog functionality, manually create a capped collection named `oplog.rs` in the `local` database. + +```js +// use local +db.createCollection('oplog.rs', { capped: true, size: 536870912 }) +``` + +You may also need to set the replica set name using [`--repl-set-name` flag / `FERRETDB_REPL_SET_NAME` environment variable](flags.md#general). + +:::tip +**`--repl-set-name` flag / `FERRETDB_REPL_SET_NAME`** environment variable allow clients and drivers to perform an initial replication handshake. +We do not perform any replication but clients and drivers will assume that the replication protocol is being used. +The purpose of this flag is to allow access to the OpLOg. +::: + +```sh +docker run -e FERRETDB_REPL_SET_NAME=rs0 ... +``` + +To query the OpLog: + +```js +db.oplog.rs.find() +``` + +To query OpLog for all the operations in a particular namespace (`test.foo`), run: + +```js +db.oplog.rs.find({ ns: 'test.foo' }) +``` + +If something does not work correctly or you have any question on the OpLog functionality, [please inform us here](https://github.com/FerretDB/FerretDB/issues/new?assignees=ferretdb-bot&labels=code%2Fbug%2Cnot+ready&projects=&template=bug.yml). diff --git a/website/versioned_docs/version-v1.17/contributing/_category_.yml b/website/versioned_docs/version-v1.20/contributing/_category_.yml similarity index 100% rename from website/versioned_docs/version-v1.17/contributing/_category_.yml rename to website/versioned_docs/version-v1.20/contributing/_category_.yml diff --git a/website/versioned_docs/version-v1.17/contributing/how-to-contribute.md b/website/versioned_docs/version-v1.20/contributing/how-to-contribute.md similarity index 100% rename from website/versioned_docs/version-v1.17/contributing/how-to-contribute.md rename to website/versioned_docs/version-v1.20/contributing/how-to-contribute.md diff --git a/website/versioned_docs/version-v1.17/contributing/writing-guide.md b/website/versioned_docs/version-v1.20/contributing/writing-guide.md similarity index 100% rename from website/versioned_docs/version-v1.17/contributing/writing-guide.md rename to website/versioned_docs/version-v1.20/contributing/writing-guide.md diff --git a/website/versioned_docs/version-v1.17/diff.md b/website/versioned_docs/version-v1.20/diff.md similarity index 100% rename from website/versioned_docs/version-v1.17/diff.md rename to website/versioned_docs/version-v1.20/diff.md diff --git a/website/versioned_docs/version-v1.17/indexes.md b/website/versioned_docs/version-v1.20/indexes.md similarity index 100% rename from website/versioned_docs/version-v1.17/indexes.md rename to website/versioned_docs/version-v1.20/indexes.md diff --git a/website/versioned_docs/version-v1.17/main.md b/website/versioned_docs/version-v1.20/main.md similarity index 100% rename from website/versioned_docs/version-v1.17/main.md rename to website/versioned_docs/version-v1.20/main.md diff --git a/website/versioned_docs/version-v1.17/migration/_category_.yml b/website/versioned_docs/version-v1.20/migration/_category_.yml similarity index 100% rename from website/versioned_docs/version-v1.17/migration/_category_.yml rename to website/versioned_docs/version-v1.20/migration/_category_.yml diff --git a/website/versioned_docs/version-v1.17/migration/migrating-from-mongodb.md b/website/versioned_docs/version-v1.20/migration/migrating-from-mongodb.md similarity index 100% rename from website/versioned_docs/version-v1.17/migration/migrating-from-mongodb.md rename to website/versioned_docs/version-v1.20/migration/migrating-from-mongodb.md diff --git a/website/versioned_docs/version-v1.17/migration/premigration-testing.md b/website/versioned_docs/version-v1.20/migration/premigration-testing.md similarity index 100% rename from website/versioned_docs/version-v1.17/migration/premigration-testing.md rename to website/versioned_docs/version-v1.20/migration/premigration-testing.md diff --git a/website/versioned_docs/version-v1.17/operators/_category_.yml b/website/versioned_docs/version-v1.20/operators/_category_.yml similarity index 100% rename from website/versioned_docs/version-v1.17/operators/_category_.yml rename to website/versioned_docs/version-v1.20/operators/_category_.yml diff --git a/website/versioned_docs/version-v1.17/operators/query/_category_.yml b/website/versioned_docs/version-v1.20/operators/query/_category_.yml similarity index 100% rename from website/versioned_docs/version-v1.17/operators/query/_category_.yml rename to website/versioned_docs/version-v1.20/operators/query/_category_.yml diff --git a/website/versioned_docs/version-v1.17/operators/query/array-operators.md b/website/versioned_docs/version-v1.20/operators/query/array-operators.md similarity index 100% rename from website/versioned_docs/version-v1.17/operators/query/array-operators.md rename to website/versioned_docs/version-v1.20/operators/query/array-operators.md diff --git a/website/versioned_docs/version-v1.17/operators/query/bitwise-operators.md b/website/versioned_docs/version-v1.20/operators/query/bitwise-operators.md similarity index 100% rename from website/versioned_docs/version-v1.17/operators/query/bitwise-operators.md rename to website/versioned_docs/version-v1.20/operators/query/bitwise-operators.md diff --git a/website/versioned_docs/version-v1.17/operators/query/comparison-operators.md b/website/versioned_docs/version-v1.20/operators/query/comparison-operators.md similarity index 100% rename from website/versioned_docs/version-v1.17/operators/query/comparison-operators.md rename to website/versioned_docs/version-v1.20/operators/query/comparison-operators.md diff --git a/website/versioned_docs/version-v1.17/operators/query/element-operators.md b/website/versioned_docs/version-v1.20/operators/query/element-operators.md similarity index 100% rename from website/versioned_docs/version-v1.17/operators/query/element-operators.md rename to website/versioned_docs/version-v1.20/operators/query/element-operators.md diff --git a/website/versioned_docs/version-v1.17/operators/query/evaluation-operators.md b/website/versioned_docs/version-v1.20/operators/query/evaluation-operators.md similarity index 100% rename from website/versioned_docs/version-v1.17/operators/query/evaluation-operators.md rename to website/versioned_docs/version-v1.20/operators/query/evaluation-operators.md diff --git a/website/versioned_docs/version-v1.17/operators/query/logical-operators.md b/website/versioned_docs/version-v1.20/operators/query/logical-operators.md similarity index 100% rename from website/versioned_docs/version-v1.17/operators/query/logical-operators.md rename to website/versioned_docs/version-v1.20/operators/query/logical-operators.md diff --git a/website/versioned_docs/version-v1.17/operators/update/_category_.yml b/website/versioned_docs/version-v1.20/operators/update/_category_.yml similarity index 100% rename from website/versioned_docs/version-v1.17/operators/update/_category_.yml rename to website/versioned_docs/version-v1.20/operators/update/_category_.yml diff --git a/website/versioned_docs/version-v1.17/operators/update/array-update-operators.md b/website/versioned_docs/version-v1.20/operators/update/array-update-operators.md similarity index 100% rename from website/versioned_docs/version-v1.17/operators/update/array-update-operators.md rename to website/versioned_docs/version-v1.20/operators/update/array-update-operators.md diff --git a/website/versioned_docs/version-v1.17/operators/update/field-update-operators.md b/website/versioned_docs/version-v1.20/operators/update/field-update-operators.md similarity index 100% rename from website/versioned_docs/version-v1.17/operators/update/field-update-operators.md rename to website/versioned_docs/version-v1.20/operators/update/field-update-operators.md diff --git a/website/versioned_docs/version-v1.17/pushdown.md b/website/versioned_docs/version-v1.20/pushdown.md similarity index 100% rename from website/versioned_docs/version-v1.17/pushdown.md rename to website/versioned_docs/version-v1.20/pushdown.md diff --git a/website/versioned_docs/version-v1.17/quickstart-guide/_category_.yml b/website/versioned_docs/version-v1.20/quickstart-guide/_category_.yml similarity index 100% rename from website/versioned_docs/version-v1.17/quickstart-guide/_category_.yml rename to website/versioned_docs/version-v1.20/quickstart-guide/_category_.yml diff --git a/website/versioned_docs/version-v1.17/quickstart-guide/deb.md b/website/versioned_docs/version-v1.20/quickstart-guide/deb.md similarity index 100% rename from website/versioned_docs/version-v1.17/quickstart-guide/deb.md rename to website/versioned_docs/version-v1.20/quickstart-guide/deb.md diff --git a/website/versioned_docs/version-v1.17/quickstart-guide/docker.md b/website/versioned_docs/version-v1.20/quickstart-guide/docker.md similarity index 100% rename from website/versioned_docs/version-v1.17/quickstart-guide/docker.md rename to website/versioned_docs/version-v1.20/quickstart-guide/docker.md diff --git a/website/versioned_docs/version-v1.17/quickstart-guide/go.md b/website/versioned_docs/version-v1.20/quickstart-guide/go.md similarity index 100% rename from website/versioned_docs/version-v1.17/quickstart-guide/go.md rename to website/versioned_docs/version-v1.20/quickstart-guide/go.md diff --git a/website/versioned_docs/version-v1.17/quickstart-guide/macos.md b/website/versioned_docs/version-v1.20/quickstart-guide/macos.md similarity index 100% rename from website/versioned_docs/version-v1.17/quickstart-guide/macos.md rename to website/versioned_docs/version-v1.20/quickstart-guide/macos.md diff --git a/website/versioned_docs/version-v1.17/quickstart-guide/rpm.md b/website/versioned_docs/version-v1.20/quickstart-guide/rpm.md similarity index 100% rename from website/versioned_docs/version-v1.17/quickstart-guide/rpm.md rename to website/versioned_docs/version-v1.20/quickstart-guide/rpm.md diff --git a/website/versioned_docs/version-v1.17/quickstart-guide/windows.md b/website/versioned_docs/version-v1.20/quickstart-guide/windows.md similarity index 100% rename from website/versioned_docs/version-v1.17/quickstart-guide/windows.md rename to website/versioned_docs/version-v1.20/quickstart-guide/windows.md diff --git a/website/versioned_docs/version-v1.17/reference/_category_.yml b/website/versioned_docs/version-v1.20/reference/_category_.yml similarity index 100% rename from website/versioned_docs/version-v1.17/reference/_category_.yml rename to website/versioned_docs/version-v1.20/reference/_category_.yml diff --git a/website/versioned_docs/version-v1.17/reference/glossary.md b/website/versioned_docs/version-v1.20/reference/glossary.md similarity index 100% rename from website/versioned_docs/version-v1.17/reference/glossary.md rename to website/versioned_docs/version-v1.20/reference/glossary.md diff --git a/website/versioned_docs/version-v1.17/reference/supported-commands.md b/website/versioned_docs/version-v1.20/reference/supported-commands.md similarity index 98% rename from website/versioned_docs/version-v1.17/reference/supported-commands.md rename to website/versioned_docs/version-v1.20/reference/supported-commands.md index 178d91696f5b..40d659de3e81 100644 --- a/website/versioned_docs/version-v1.17/reference/supported-commands.md +++ b/website/versioned_docs/version-v1.20/reference/supported-commands.md @@ -41,10 +41,10 @@ Use ❌ for commands and arguments that are not implemented at all. | | `min` | ⚠️ | Ignored | | | `returnKey` | ❌ | Unimplemented | | | `showRecordId` | ✅ | | -| | `tailable` | ❌ | [Issue](https://github.com/FerretDB/FerretDB/issues/2283) | -| | `oplogReplay` | ❌ | Unimplemented | -| | `noCursorTimeout` | ❌ | Unimplemented | -| | `awaitData` | ❌ | [Issue](https://github.com/FerretDB/FerretDB/issues/2283) | +| | `tailable` | ✅ | | +| | `oplogReplay` | ⚠️ | Ignored | +| | `noCursorTimeout` | ❌ | [Issue](https://github.com/FerretDB/FerretDB/issues/4035) | +| | `awaitData` | ✅ | | | | `allowPartialResults` | ❌ | Unimplemented | | | `collation` | ❌ | Unimplemented | | | `allowDiskUse` | ⚠️ | Ignored | @@ -66,7 +66,7 @@ Use ❌ for commands and arguments that are not implemented at all. | | `let` | ⚠️ | Unimplemented | | `getMore` | | ✅ | Basic command is fully supported | | | `batchSize` | ✅ | | -| | `maxTimeMS` | ⚠️ | [Issue](https://github.com/FerretDB/FerretDB/issues/2984) | +| | `maxTimeMS` | ✅ | | | | `comment` | ⚠️ | Unimplemented | | `insert` | | ✅ | Basic command is fully supported | | | `documents` | ✅ | | @@ -171,7 +171,7 @@ Related [issue](https://github.com/FerretDB/FerretDB/issues/78). | Command | Argument | Status | Comments | | -------------------------- | -------------------------------- | ------ | --------------------------------------------------------- | -| `createUser` | | ❌ | [Issue](https://github.com/FerretDB/FerretDB/issues/1491) | +| `createUser` | | ✅ | | | | `pwd` | ⚠️ | | | | `customData` | ⚠️ | | | | `roles` | ⚠️ | | @@ -181,10 +181,10 @@ Related [issue](https://github.com/FerretDB/FerretDB/issues/78). | | `mechanisms` | ⚠️ | | | | `digestPassword` | ⚠️ | | | | `comment` | ⚠️ | | -| `dropAllUsersFromDatabase` | | ❌ | [Issue](https://github.com/FerretDB/FerretDB/issues/1492) | +| `dropAllUsersFromDatabase` | | ✅ | | | | `writeConcern` | ⚠️ | | | | `comment` | ⚠️ | | -| `dropUser` | | ❌ | [Issue](https://github.com/FerretDB/FerretDB/issues/1493) | +| `dropUser` | | ✅ | | | | `writeConcern` | ⚠️ | | | | `comment` | ⚠️ | | | `grantRolesToUser` | | ❌ | [Issue](https://github.com/FerretDB/FerretDB/issues/1494) | @@ -204,7 +204,7 @@ Related [issue](https://github.com/FerretDB/FerretDB/issues/78). | | `mechanisms` | ⚠️ | | | | `digestPassword` | ⚠️ | | | | `comment` | ⚠️ | | -| `usersInfo` | | ❌ | [Issue](https://github.com/FerretDB/FerretDB/issues/1497) | +| `usersInfo` | | ✅ | | | | `showCredentials` | ⚠️ | | | | `showCustomData` | ⚠️ | | | | `showPrivileges` | ⚠️ | | @@ -265,6 +265,12 @@ Related [issue](https://github.com/FerretDB/FerretDB/issues/78). | | `writeConcern` | ⚠️ | | | | `comment` | ⚠️ | | +### Replication Commands + +| Command | Argument | Status | Comments | +| ----------------- | -------- | ------ | --------------------------------------------------------- | +| `replSetInitiate` | | ❌ | [Issue](https://github.com/FerretDB/FerretDB/issues/3936) | + ## Session Commands Related [issue](https://github.com/FerretDB/FerretDB/issues/8). @@ -562,7 +568,7 @@ Related [issue](https://github.com/FerretDB/FerretDB/issues/1917). | | `expireAfterSeconds` | | ⚠️ | [Issue](https://github.com/FerretDB/FerretDB/issues/2415) | | | `clusteredIndex` | | ⚠️ | | | | `changeStreamPreAndPostImages` | | ⚠️ | | -| | `autoIndexId` | | ⚠️ | Ignored | +| | `autoIndexId` | | ⚠️ | [Issue](https://github.com/FerretDB/FerretDB/issues/3922) | | | `size` | | ✅️ | | | | `max` | | ✅ | | | | `storageEngine` | | ⚠️ | Ignored | diff --git a/website/versioned_docs/version-v1.17/security/_category_.yml b/website/versioned_docs/version-v1.20/security/_category_.yml similarity index 100% rename from website/versioned_docs/version-v1.17/security/_category_.yml rename to website/versioned_docs/version-v1.20/security/_category_.yml diff --git a/website/versioned_docs/version-v1.17/security/authentication.md b/website/versioned_docs/version-v1.20/security/authentication.md similarity index 100% rename from website/versioned_docs/version-v1.17/security/authentication.md rename to website/versioned_docs/version-v1.20/security/authentication.md diff --git a/website/versioned_docs/version-v1.17/security/tls-connections.md b/website/versioned_docs/version-v1.20/security/tls-connections.md similarity index 100% rename from website/versioned_docs/version-v1.17/security/tls-connections.md rename to website/versioned_docs/version-v1.20/security/tls-connections.md diff --git a/website/versioned_docs/version-v1.17/telemetry.md b/website/versioned_docs/version-v1.20/telemetry.md similarity index 99% rename from website/versioned_docs/version-v1.17/telemetry.md rename to website/versioned_docs/version-v1.20/telemetry.md index 281fcb991ee7..e5ed588e2f7f 100644 --- a/website/versioned_docs/version-v1.17/telemetry.md +++ b/website/versioned_docs/version-v1.20/telemetry.md @@ -5,7 +5,7 @@ slug: /telemetry/ # referenced in many places; must not change # Telemetry reporting -FerretDB collects basic anonymous usage data and sends them to our telemetry service ([FerretDB Beacon](https://beacon.ferretdb.io)), +FerretDB collects basic anonymous usage data and sends them to our telemetry service ([FerretDB Beacon](https://beacon.ferretdb.com)), which helps us understand its usage, and how we can further increase compatibility and enhance our product. It also enables us to provide you information about available updates. diff --git a/website/versioned_docs/version-v1.17/understanding-ferretdb.md b/website/versioned_docs/version-v1.20/understanding-ferretdb.md similarity index 100% rename from website/versioned_docs/version-v1.17/understanding-ferretdb.md rename to website/versioned_docs/version-v1.20/understanding-ferretdb.md diff --git a/website/versioned_sidebars/version-v1.17-sidebars.json b/website/versioned_sidebars/version-v1.20-sidebars.json similarity index 100% rename from website/versioned_sidebars/version-v1.17-sidebars.json rename to website/versioned_sidebars/version-v1.20-sidebars.json diff --git a/website/versions.json b/website/versions.json index 839a21af7dd6..761f89341462 100644 --- a/website/versions.json +++ b/website/versions.json @@ -1,5 +1,5 @@ [ + "v1.20", "v1.19", - "v1.18", - "v1.17" + "v1.18" ]