Skip to content
Merged
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: 1 addition & 1 deletion cloud/cloud-instances.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ to create a **free**-tier instance.
A development server is equipped with all of RavenDB's [features](https://ravendb.net/buy)
but is **not** suitable for production for the following reasons:

* A single-node configuration (no [replication](../7.1/server/clustering/replication/replication)).
* A single-node configuration (no [replication](../7.1/server/clustering/replication/replication-overview)).
* [Burstable](../cloud/cloud-overview.mdx#burstable-instances) CPU usage, suitable for small to medium production loads.
Burstable instances can become throttled if usage exceeds allocated resources.
* Lack of [backup](../cloud/cloud-backup-and-restore.mdx#cloud-backup) procedure.
Expand Down
6 changes: 3 additions & 3 deletions docs/ai-integration/generating-embeddings/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,10 @@ import LanguageContent from "@site/src/components/LanguageContent";
where you can track processing duration, batch sizes, and overall progress.
Learn more about the functionality of the stats view in the [Ongoing Tasks Stats](../../studio/database/stats/ongoing-tasks-stats/overview.mdx) article.

* The number of embeddings generation tasks across all databases can also be monitored using [SNMP](../../server/administration/snmp/snmp.mdx).
* The number of embeddings generation tasks across all databases can also be monitored using [SNMP](../../server/administration/snmp/snmp-overview.mdx).
The following SNMP OIDs provide relevant metrics:
* [5.1.11.25](../../server/administration/snmp/snmp.mdx#5.1.11.25) – Total number of enabled embeddings generation tasks.
* [5.1.11.26](../../server/administration/snmp/snmp.mdx#5.1.11.26) – Total number of active embeddings generation tasks.
* [5.1.11.25](../../server/administration/snmp/snmp-overview.mdx#5.1.11.25) – Total number of enabled embeddings generation tasks.
* [5.1.11.26](../../server/administration/snmp/snmp-overview.mdx#5.1.11.26) – Total number of active embeddings generation tasks.



6 changes: 3 additions & 3 deletions docs/client-api/faq/transaction-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ then you must enable [optimistic concurrency](../../client-api/session/configura
### Multi-master model

RavenDB employs the multi-master model, allowing writes to be made to any node in the cluster.
These writes are then propagated asynchronously to the other nodes via [replication](../../server/clustering/replication/replication.mdx).
These writes are then propagated asynchronously to the other nodes via [replication](../../server/clustering/replication/replication-overview.mdx).

The interaction of transactions and distributed work is anything but trivial. Let's start from the obvious problem:

Expand Down Expand Up @@ -174,11 +174,11 @@ If you care about avoiding lost updates, you need to ensure you have the conflic

The following is an important aspect to RavenDB's transactional behavior with regards to asynchronous replication.

When replicating modifications to another server, RavenDB will ensure that the [transaction boundaries](../../server/clustering/replication/replication.mdx#replication-&-transaction-boundary) are maintained.
When replicating modifications to another server, RavenDB will ensure that the [transaction boundaries](../../server/clustering/replication/replication-overview.mdx#replication-&-transaction-boundary) are maintained.
If there are several document modifications in the same transaction they will be sent in the same replication batch, keeping the transaction boundary on the destination as well.

However, a special attention is needed when a document is modified in two separate transactions but the replication of the first transaction has not occurred yet.
Read more about that in [How revisions replication help data consistency](../../server/clustering/replication/replication.mdx#how-revisions-replication-help-data-consistency).
Read more about that in [How revisions replication help data consistency](../../server/clustering/replication/replication-overview.mdx#how-revisions-replication-help-data-consistency).

<hr/>

Expand Down
32 changes: 16 additions & 16 deletions docs/client-api/operations/maintenance/backup/backup-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,26 @@ import LanguageContent from "@site/src/components/LanguageContent";
* RavenDB's Backup task is an [Ongoing-Task](../../../../studio/database/tasks/ongoing-tasks/general-info.mdx)
designed to run periodically on a pre-defined schedule.
You can run it as a one-time operation as well, by using [Export](../../../../client-api/smuggler/what-is-smuggler.mdx#export)
or executing a backup task [immediately](../../../../client-api/operations/maintenance/backup/backup.mdx#initiate-immediate-backup-execution).
or executing a backup task [immediately](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#initiate-immediate-backup-execution).

* On a [sharded](../../../../sharding/overview.mdx) database, a single backup task
is defined by the user for all shards, and RavenDB automatically defines
sub-tasks that create backups per shard.
Read about backups on a sharded database [in the section dedicated to it](../../../../sharding/backup-and-restore/backup.mdx).

* In this page:
* [Backup Types](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-types)
* [Logical-Backup](../../../../client-api/operations/maintenance/backup/backup.mdx#logical-backup)
* [Snapshot](../../../../client-api/operations/maintenance/backup/backup.mdx#snapshot)
* [Backup Scope](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-scope)
* [Full Backup](../../../../client-api/operations/maintenance/backup/backup.mdx#full-backup)
* [Incremental Backup](../../../../client-api/operations/maintenance/backup/backup.mdx#incremental-backup)
* [Backup to Local and Remote Destinations](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-to-local-and-remote-destinations)
* [Backup Retention Policy](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-retention-policy)
* [Server-Wide Backup](../../../../client-api/operations/maintenance/backup/backup.mdx#server-wide-backup)
* [Initiate Immediate Backup Execution](../../../../client-api/operations/maintenance/backup/backup.mdx#initiate-immediate-backup-execution)
* [Delay Backup Execution](../../../../client-api/operations/maintenance/backup/backup.mdx#delay-backup-execution)
* [Recommended Precautions](../../../../client-api/operations/maintenance/backup/backup.mdx#recommended-precautions)
* [Backup Types](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-types)
* [Logical-Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#logical-backup)
* [Snapshot](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#snapshot)
* [Backup Scope](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-scope)
* [Full Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#full-backup)
* [Incremental Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#incremental-backup)
* [Backup to Local and Remote Destinations](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-to-local-and-remote-destinations)
* [Backup Retention Policy](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-retention-policy)
* [Server-Wide Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#server-wide-backup)
* [Initiate Immediate Backup Execution](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#initiate-immediate-backup-execution)
* [Delay Backup Execution](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#delay-backup-execution)
* [Recommended Precautions](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#recommended-precautions)

</Admonition>
## Backup Types
Expand Down Expand Up @@ -111,7 +111,7 @@ var result = await docStore.Maintenance.SendAsync(operation);
* If Incremental backups are created for a Snapshot-type backup:
* The first backup will be a full Snapshot.
* The following backups will be Incremental.
* [Incremental backups](../../../../client-api/operations/maintenance/backup/backup.mdx#incremental-backup)
* [Incremental backups](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#incremental-backup)
have different storage contents than Snapshots.

* Code Sample:
Expand Down Expand Up @@ -361,7 +361,7 @@ The retention policy is a property of `PeriodicBackupConfiguration`:
You can create a Server-Wide Backup task to back-up **all the databases in your cluster** at a scheduled time.
Individual databases can be excluded from the backup. Learn more in [Studio: Server-Wide Backup](../../../../studio/server/server-wide-backup.mdx).

Backups can be made locally, as well as to a [set of remote locations](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-to-local-and-remote-destinations).
Backups can be made locally, as well as to a [set of remote locations](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-to-local-and-remote-destinations).

#### Examples

Expand Down Expand Up @@ -585,7 +585,7 @@ await docStore.Maintenance.SendAsync(
* An ACIDity of backed-up data, to keep its independence during restoration.

* **Remove old backup files regularly**.
Set the [backup retention policy](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-retention-policy)
Set the [backup retention policy](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-retention-policy)
to remove unneeded backup files so that they don't build up.
While setting how many days to keep your backups, consider how much of a recent database history you would like to have access to.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,17 +104,17 @@ Secure the data stored on the server by
can be different than the original database encryption key.

* **Snapshot**
A [snapshot](../../../../client-api/operations/maintenance/backup/backup.mdx#snapshot) is an exact image of your database.
A [snapshot](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#snapshot) is an exact image of your database.
If the database is **not encrypted**, its snapshot wouldn't be either.
If the database is **encrypted**, its snapshot would also be encrypted using the database encryption key.
If you want your snapshot to be encrypted, simply take the snapshot of an
[encrypted database](../../../../server/security/encryption/database-encryption.mdx#creating-an-encrypted-database-using-the-rest-api-and-the-client-api).
#### Choosing Encryption Mode & Key

Use the same [Backup](../../../../client-api/operations/maintenance/backup/backup.mdx#backup) and [Restore](../../../../client-api/operations/maintenance/backup/restore.mdx) methods that are used to create and restore **un**-encrypted backups.
Use the same [Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup) and [Restore](../../../../client-api/operations/maintenance/backup/restore.mdx) methods that are used to create and restore **un**-encrypted backups.
Specify whether encryption is used, and with which encryption key,
in the **BackupEncryptionSettings** structure defined within the
[PeriodicBackupConfiguration](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-to-local-and-remote-destinations) object.
[PeriodicBackupConfiguration](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-to-local-and-remote-destinations) object.

* `BackupEncryptionSettings` definition:
<TabItem value="BackupEncryptionSettings_definition" label="BackupEncryptionSettings_definition">
Expand Down
6 changes: 3 additions & 3 deletions docs/client-api/operations/maintenance/backup/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ time-signatures are consistent even when the backups are created by different no
### Is an External Replication task a good substitute for a backup task?

Although [External Replication](../../../../studio/database/tasks/ongoing-tasks/external-replication-task.mdx)
and [Backup](../../../../client-api/operations/maintenance/backup/backup.mdx)
and [Backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx)
are both ongoing tasks that create a copy of your data, they have different aims and behavior.

For example, replication tasks don't allow you to retrieve data from a history/restore point after mistakes,
Expand All @@ -74,7 +74,7 @@ See [Backup Task -vs- External Replication Task](../../../../studio/database/tas
### Can I simply copy the database folder contents whenever I need to create a backup?

Simply copying the database folder of a live database will probably create corrupted data in the backup.
Creating an [ongoing backup task](../../../../client-api/operations/maintenance/backup/backup.mdx) is a one-time operation.
Creating an [ongoing backup task](../../../../client-api/operations/maintenance/backup/backup-overview.mdx) is a one-time operation.
There really is no reason to do it manually again and again.
There really is no reason to do it manually again and again. Properly backing up provides:

Expand All @@ -88,7 +88,7 @@ If you enable it, RavenDB will delete backups after the `TimeSpan` that you set.
By default, `RetentionPolicy` is disabled.

Learn how to change the [Retention Policy via the RavenDB Studio](../../../../studio/database/tasks/backup-task.mdx#retention-policy).
Learn how to change the [Retention Policy via API](../../../../client-api/operations/maintenance/backup/backup.mdx#backup-retention-policy).
Learn how to change the [Retention Policy via API](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#backup-retention-policy).
### Are there any locations that backup files should NOT be stored at?

It is recommended **not to store backups on the same drive as your database** data files,
Expand Down
4 changes: 2 additions & 2 deletions docs/client-api/operations/maintenance/backup/restore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -183,11 +183,11 @@ You can create the cluster in advance, and restore the database to multiple node

<Admonition type="note" title="This procedure is advisable only when restoring a Snapshot." id="this-procedure-is-advisable-only-when-restoring-a-snapshot" href="#this-procedure-is-advisable-only-when-restoring-a-snapshot">

* When a [logical-backup](../../../../client-api/operations/maintenance/backup/backup.mdx#logical-backup)
* When a [logical-backup](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#logical-backup)
is restored, each document receives a new change-vector according to the node it resides on.
When the database instances synchronize, this change-vector will be updated and be composed of all database nodes tags.

* When a [snapshot](../../../../client-api/operations/maintenance/backup/backup.mdx#snapshot) is restored,
* When a [snapshot](../../../../client-api/operations/maintenance/backup/backup-overview.mdx#snapshot) is restored,
documents are **not** assigned a new change-vector because the databases kept by all nodes are considered identical.
Each document retains the original change-vector it had during backup.
When the database instances synchronize, documents' change-vectors do **not** change.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-archival/archived-documents-and-other-features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -548,8 +548,8 @@ loadToOrders(this);

## Archived documents and replication

Archived documents are included in [Internal](../server/clustering/replication/replication.mdx#internal-replication) replication,
[External](../server/clustering/replication/replication.mdx#external-replication) replication, and [Hub/Sink](../server/clustering/replication/replication.mdx#hubsink-replication) replication -
Archived documents are included in [Internal](../server/clustering/replication/replication-overview.mdx#internal-replication) replication,
[External](../server/clustering/replication/replication-overview.mdx#external-replication) replication, and [Hub/Sink](../server/clustering/replication/replication-overview.mdx#hubsink-replication) replication -
no special configuration is required.


Expand Down
2 changes: 1 addition & 1 deletion docs/data-archival/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ import LanguageContent from "@site/src/components/LanguageContent";
* The server scans the database periodically (at an interval specified when the task is enabled),
identifies documents scheduled for archiving, and archives them at the scheduled time.
* In a cluster, the archiving task runs on the [preferred node](../client-api/configuration/load-balance/overview.mdx#the-preferred-node) (the first node in the cluster topology).
Archived documents are then propagated to the other nodes through [internal replication](../server/clustering/replication/replication.mdx#internal-replication).
Archived documents are then propagated to the other nodes through [internal replication](../server/clustering/replication/replication-overview.mdx#internal-replication).

* **What is archived**
* The JSON document itself is archived.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export const supportedLanguages = ["csharp"];
even if these settings are disabled.

* When working with a secure server:
* The delete revisions action will be logged in the [audit log](../../../../server/security/audit-log/audit-log.mdx).
* The delete revisions action will be logged in the [audit log](../../../../server/security/audit-log/audit-log-overview.mdx).
* This operation is only available for a client certificate with a [security clearance](../../../../server/security/authorization/security-clearance-and-permissions.mdx) of _DatabaseAdmin_ or higher.

* By default, the operation will be applied to the [default database](../../../../client-api/setting-up-default-database.mdx).
Expand Down
Loading