Skip to content

Commit

Permalink
docs: add links to new sync framework on old replication pages
Browse files Browse the repository at this point in the history
  • Loading branch information
maxnowack committed Sep 18, 2024
1 parent 8d4a77b commit 6460d69
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/replication/appwrite/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ head:
---
# Integrate SignalDB with [Appwrite](https://appwrite.io/)

::: warning
This section of the documentation is deprecated in favor of the [`SyncManager`](/sync/reference/). Please also see the new documentation pages about [data synchronization](/sync/) and [sync implementation](/sync/implementation/).
:::

In the landscape of contemporary web applications, ensuring data persistence and consistency is increasingly important. SignalDB stands out for its efficiency as an in-memory database, but it faces the challenge of potential data loss during events like page reloads. This is where the role of persistence adapters becomes essential, particularly for platforms like Appwrite. Appwrite, a backend server for web, mobile, and Flutter developers, offers a range of features that can greatly enhance SignalDB’s capabilities. Integrating an Appwrite persistence adapter not only ensures data persistence within SignalDB but also allows for smooth integration with Appwrite’s services.

The primary role of persistence adapters in SignalDB is to act as connectors between SignalDB and various storage solutions. In this case, the adapter links SignalDB with Appwrite’s database and storage services. These adapters effectively translate the high-level data operations used in applications into the low-level operations compatible with Appwrite’s storage systems. The integration of an Appwrite persistence adapter means that developers can harness Appwrite's database management aligning it with SignalDB. The aim is to use the persistence adapter to store data within Appwrite, ensuring secure management and accessibility.
Expand Down
4 changes: 4 additions & 0 deletions docs/replication/firebase/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ head:
---
# Integrate SignalDB with [Firebase](https://firebase.google.com/)

::: warning
This section of the documentation is deprecated in favor of the [`SyncManager`](/sync/reference/). Please also see the new documentation pages about [data synchronization](/sync/) and [sync implementation](/sync/implementation/).
:::

In the realm of modern data-driven applications, maintaining data persistence and consistency is crucial. SignalDB, known for its efficiency as an in-memory database, faces the challenge of data loss during events like page reloads. This is where the integration of persistence adapters becomes vital, particularly for services like Firebase. Firebase, a comprehensive app development platform, offers robust features that can significantly enhance SignalDB's functionality. Implementing a Firebase persistence adapter not only secures data persistence in SignalDB but also enables seamless integration with Firebase's extensive suite of features.

Exploring the role of persistence adapters within SignalDB, their primary function is to act as a bridge between SignalDB and various storage solutions, including Firebase's Firestore, Realtime Database, or cloud storage. These adapters are designed to translate high-level data operations, typical in applications, into the low-level operations compatible with Firebase's storage systems. The integration of a Firebase persistence adapter allows developers to leverage Firebase's advanced capabilities, such as real-time data synchronization, authentication, and cloud storage. This means using the adapter to store data within Firebase's ecosystem, ensuring it is securely managed and easily accessible.
Expand Down
4 changes: 4 additions & 0 deletions docs/replication/http/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ head:
---
# Replicating Data with External HTTP REST API in SignalDB

::: warning
This section of the documentation is deprecated in favor of the [`SyncManager`](/sync/reference/). Please also see the new documentation pages about [data synchronization](/sync/) and [sync implementation](/sync/implementation/).
:::

If you've familiarized yourself with the [Replication Overview](/replication/), you're likely already acquainted with the process of achieving replication using an external HTTP REST API.

This page is dedicated to guiding you through the utilization of your existing HTTP REST API for data replication with SignalDB.
Expand Down
4 changes: 4 additions & 0 deletions docs/replication/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ head:
---
# Data Replication in SignalDB

::: warning
This feature was deprecated in favor of the [`SyncManager`](/sync/reference/). Please also see the new documentation pages about [data synchronization](/sync/) and [sync implementation](/sync/implementation/).
:::

For seamless integration of your app with remote services, SignalDB offers robust data replication capabilities. Whether you're building a local app or sharing data across multiple clients, SignalDB's modular replication system ensures efficient data synchronization.


Expand Down
4 changes: 4 additions & 0 deletions docs/replication/other/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ head:
---
# Other Replication Options

::: warning
This section of the documentation is deprecated in favor of the [`SyncManager`](/sync/reference/). Please also see the new documentation pages about [data synchronization](/sync/) and [sync implementation](/sync/implementation/).
:::

If the provided replication options don't suit your needs, you can always implement your own replication logic. SignalDB provides a flexible API that allows you to create custom replication logic with any external data source. You can take a look at the [`ReplicatedCollection` class](https://github.com/maxnowack/signaldb/blob/main/packages/signaldb/src/ReplicatedCollection.ts) to get started.

Another option is to use the [RxDB Persistence Adapter](/data-persistence/rxdb/), which allows you to use the replication functionality of RxDB together with SignalDB. The replication protocol of RxDB is currently more powerful and maybe fills your needs better.
Expand Down
4 changes: 4 additions & 0 deletions docs/replication/supabase/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ head:
---
# Integrate SignalDB with [Supabase](https://supabase.io/)

::: warning
This section of the documentation is deprecated in favor of the [`SyncManager`](/sync/reference/). Please also see the new documentation pages about [data synchronization](/sync/) and [sync implementation](/sync/implementation/).
:::

In the evolving world of web applications, the importance of data persistence and consistency cannot be overstated. While SignalDB excels as an efficient in-memory database, it faces the risk of data loss during events like page reloads. Addressing this challenge, the integration of persistence adapters, such as one for Supabase, becomes critical. Supabase, an open-source Firebase alternative, provides a suite of powerful features that can significantly augment SignalDB's functionality. Incorporating a Supabase persistence adapter ensures not only the persistence of data within SignalDB but also enables seamless interaction with Supabase’s real-time database and authentication services.

The role of persistence adapters within SignalDB is to facilitate a connection between SignalDB and various storage solutions, in this case, Supabase’s PostgreSQL database and storage services. These adapters convert the high-level data operations of applications into low-level operations that are compatible with Supabase's storage system. With a Supabase persistence adapter integrated, developers can leverage the platform's capabilities, including real-time data updates, secure user authentication, and efficient data storage, aligning them with SignalDB’s in-memory data handling. The aim is to utilize the persistence adapter for storing and managing data within the robust framework of Supabase.
Expand Down

0 comments on commit 6460d69

Please sign in to comment.