Skip to content

Commit 63d4357

Browse files
kensodemannKen Sodemann
andauthored
docs(storage): replace outdated or sunset products with active projects (#4238)
Co-authored-by: Ken Sodemann <[email protected]>
1 parent 6df374d commit 63d4357

File tree

6 files changed

+190
-68
lines changed

6 files changed

+190
-68
lines changed

docs/angular/storage.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,44 @@ sidebar_label: Storage
77
<title>Angular App Data Storage Options - Ionic Documentation</title>
88
<meta
99
name="description"
10-
content="A variety of options are available for storing data within Ionic apps made using Angular. Read our documentation for Ionic Secure Storage and @ionic/storage."
10+
content="A variety of options are available for storing data within Ionic apps made using Angular. Choose the options that best fit your storage needs."
1111
/>
1212
</head>
1313

14-
There are variety of options available for storing data within an Ionic app.
14+
There are a variety of options available for storing data within an Ionic application. It is best to choose options that best fit the needs of your application. A single application may have requirements that span multiple options.
1515

16-
Here are two official Ionic options:
16+
:::info
17+
Some storage options involve third-party plugins or products. In such cases, we neither endorse nor support those plugins or products. We are mentioning them here for informational purposes only.
18+
:::
1719

18-
## Ionic Secure Storage
20+
Here are some common use cases and solutions:
1921

20-
For teams building mission-critical apps or requiring encryption support, [Ionic Secure Storage](https://ionic.io/docs/secure-storage) is an official premium solution from the Ionic team that provides a cross-platform data storage system that works on iOS and Android.
22+
## Local Application Settings and Data
2123

22-
It makes it easy to build high performance, offline-ready Ionic apps across iOS, Android, and the web.
24+
Many applications need to locally store settings as well as other lightweight key/value data. The [Capacitor Preferences](https://capacitorjs.com/docs/apis/preferences) plugin is specifically designed to handle these scenarios.
2325

24-
[Learn more](https://ionic.io/products/secure-storage)
26+
## Relational Data Storage (Mobile Only)
2527

26-
## @ionic/storage
28+
Some applications, especially those following an offline-first methodology, may require locally storing high volumes of complex relational data. For such scenarios, a SQLite plugin may be used. The most common SQLite plugin offerings are:
2729

28-
For developers not requiring encryption nor relational data support, [@ionic/storage](https://github.com/ionic-team/ionic-storage) is an open source key/value API for building apps that work across storage engines on multiple platforms.
30+
- [Cordova SQLite Storage](https://github.com/storesafe/cordova-sqlite-storage) (a [convenience wrapper](https://danielsogl.gitbook.io/awesome-cordova-plugins/sqlite) also exists for this plugin to aid in implementation)
31+
- [Capacitor Community SQLite Plugin](https://github.com/capacitor-community/sqlite)
2932

30-
Additionally, Ionic Secure Storage has a driver that works with the key/value API in `@ionic/storage` while providing encryption and SQLite support.
33+
## Non-Relational High Volume Data Storage (Mobile and Web)
3134

32-
Learn more about [@ionic/storage](https://github.com/ionic-team/ionic-storage)
35+
For applications that need to store a high volume of data as well as operate on both web and mobile, a potential solution is to create a key/value pair data storage service that uses [indexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) on the web and one of the previously mentioned SQLite plugins on mobile.
36+
37+
Here a sample of how this can be accomplished:
38+
39+
- [Full application](https://github.com/ionic-enterprise/tutorials-and-demos-ng/tree/main/demos/sqlcipher-kv-pair)
40+
- [Mobile Service](https://github.com/ionic-enterprise/tutorials-and-demos-ng/blob/main/demos/sqlcipher-kv-pair/src/app/core/mobile-kv-store.ts)
41+
- [Web Service](https://github.com/ionic-enterprise/tutorials-and-demos-ng/blob/main/demos/sqlcipher-kv-pair/src/app/core/web-kv-store.ts)
42+
43+
## Other Options
44+
45+
Other storage options that provide local as well as cloud-based storage that work well within Capacitor applications also exist and may integrate well with your application.
46+
47+
For example:
48+
49+
- [PouchDB](https://pouchdb.com/)
50+
- [Firestore](https://firebase.google.com/docs/firestore)

docs/react/storage.md

Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,50 @@
11
---
2+
title: Data Storage
23
sidebar_label: Storage
34
---
45

5-
# Data Storage
6+
<head>
7+
<title>React App Data Storage Options - Ionic Documentation</title>
8+
<meta
9+
name="description"
10+
content="A variety of options are available for storing data within Ionic apps made using React. Choose the options that best fit your storage needs."
11+
/>
12+
</head>
613

7-
There are variety of options available for storing data within an Ionic app.
14+
There are a variety of options available for storing data within an Ionic application. It is best to choose options that best fit the needs of your application. A single application may have requirements that span multiple options.
815

9-
Here are two official Ionic options:
16+
:::info
17+
Some storage options involve third-party plugins or products. In such cases, we neither endorse nor support those plugins or products. We are mentioning them here for informational purposes only.
18+
:::
1019

11-
## Ionic Secure Storage
20+
Here are some common use cases and solutions:
1221

13-
For teams building mission-critical apps or requiring encryption support, [Ionic Secure Storage](https://ionic.io/docs/secure-storage) is an official premium solution from the Ionic team that provides a cross-platform data storage system that works on iOS and Android.
22+
## Local Application Settings and Data
1423

15-
It makes it easy to build high performance, offline-ready Ionic apps across iOS, Android, and the web.
24+
Many applications need to locally store settings as well as other lightweight key/value data. The [Capacitor Preferences](https://capacitorjs.com/docs/apis/preferences) plugin is specifically designed to handle these scenarios.
1625

17-
[Learn more](https://ionic.io/products/secure-storage)
26+
## Relational Data Storage (Mobile Only)
1827

19-
## @ionic/storage
28+
Some applications, especially those following an offline-first methodology, may require locally storing high volumes of complex relational data. For such scenarios, a SQLite plugin may be used. The most common SQLite plugin offerings are:
2029

21-
For developers not requiring encryption nor relational data support, [@ionic/storage](https://github.com/ionic-team/ionic-storage) is an open source key/value API for building apps that work across storage engines on multiple platforms.
30+
- [Cordova SQLite Storage](https://github.com/storesafe/cordova-sqlite-storage) (a [convenience wrapper](https://danielsogl.gitbook.io/awesome-cordova-plugins/sqlite) also exists for this plugin to aid in implementation)
31+
- [Capacitor Community SQLite Plugin](https://github.com/capacitor-community/sqlite)
2232

23-
Additionally, Ionic Secure Storage has a driver that works with the key/value API in `@ionic/storage` while providing encryption and SQLite support.
33+
## Non-Relational High Volume Data Storage (Mobile and Web)
2434

25-
Learn more about [@ionic/storage](https://github.com/ionic-team/ionic-storage)
35+
For applications that need to store a high volume of data as well as operate on both web and mobile, a potential solution is to create a key/value pair data storage service that uses [indexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) on the web and one of the previously mentioned SQLite plugins on mobile.
36+
37+
Here a sample of how this can be accomplished:
38+
39+
- [Full application](https://github.com/ionic-enterprise/tutorials-and-demos-react/tree/main/demos/sqlcipher-kv-pair)
40+
- [Mobile Service](https://github.com/ionic-enterprise/tutorials-and-demos-react/blob/main/demos/sqlcipher-kv-pair/src/utils/mobile-kv-store.ts)
41+
- [Web Service](https://github.com/ionic-enterprise/tutorials-and-demos-react/blob/main/demos/sqlcipher-kv-pair/src/utils/web-kv-store.ts)
42+
43+
## Other Options
44+
45+
Other storage options that provide local as well as cloud-based storage that work well within Capacitor applications also exist and may integrate well with your application.
46+
47+
For example:
48+
49+
- [PouchDB](https://pouchdb.com/)
50+
- [Firestore](https://firebase.google.com/docs/firestore)

docs/vue/storage.md

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,47 @@ sidebar_label: Storage
44
---
55

66
<head>
7-
<title>Vue App Data Storage for iOS and Android - Ionic Documentation</title>
7+
<title>Vue App Data Storage Options - Ionic Documentation</title>
88
<meta
99
name="description"
10-
content="There's a variety of options available for storing data within an Ionic app. Read our Vue data storage documentation for options on iOS, Android, and web apps."
10+
content="A variety of options are available for storing data within Ionic apps made using Vue. Choose the options that best fit your storage needs."
1111
/>
1212
</head>
1313

14-
There are variety of options available for storing data within an Ionic app.
14+
There are a variety of options available for storing data within an Ionic application. It is best to choose options that best fit the needs of your application. A single application may have requirements that span multiple options.
1515

16-
Here are two official Ionic options:
16+
:::info
17+
Some storage options involve third-party plugins or products. In such cases, we neither endorse nor support those plugins or products. We are mentioning them here for informational purposes only.
18+
:::
1719

18-
## Ionic Secure Storage
20+
Here are some common use cases and solutions:
1921

20-
For teams building mission-critical apps or requiring encryption support, [Ionic Secure Storage](https://ionic.io/docs/secure-storage) is an official premium solution from the Ionic team that provides a cross-platform data storage system that works on iOS and Android.
22+
## Local Application Settings and Data
2123

22-
It makes it easy to build high performance, offline-ready Ionic apps across iOS, Android, and the web.
24+
Many applications need to locally store settings as well as other lightweight key/value data. The [Capacitor Preferences](https://capacitorjs.com/docs/apis/preferences) plugin is specifically designed to handle these scenarios.
2325

24-
[Learn more](https://ionic.io/products/secure-storage)
26+
## Relational Data Storage (Mobile Only)
2527

26-
## @ionic/storage
28+
Some applications, especially those following an offline-first methodology, may require locally storing high volumes of complex relational data. For such scenarios, a SQLite plugin may be used. The most common SQLite plugin offerings are:
2729

28-
For developers not requiring encryption nor relational data support, [@ionic/storage](https://github.com/ionic-team/ionic-storage) is an open source key/value API for building apps that work across storage engines on multiple platforms.
30+
- [Cordova SQLite Storage](https://github.com/storesafe/cordova-sqlite-storage) (a [convenience wrapper](https://danielsogl.gitbook.io/awesome-cordova-plugins/sqlite) also exists for this plugin to aid in implementation)
31+
- [Capacitor Community SQLite Plugin](https://github.com/capacitor-community/sqlite)
2932

30-
Additionally, Ionic Secure Storage has a driver that works with the key/value API in `@ionic/storage` while providing encryption and SQLite support.
33+
## Non-Relational High Volume Data Storage (Mobile and Web)
3134

32-
Learn more about [@ionic/storage](https://github.com/ionic-team/ionic-storage)
35+
For applications that need to store a high volume of data as well as operate on both web and mobile, a potential solution is to create a key/value pair data storage service that uses [indexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) on the web and one of the previously mentioned SQLite plugins on mobile.
36+
37+
Here a sample of how this can be accomplished:
38+
39+
- [Full application](https://github.com/ionic-enterprise/tutorials-and-demos-vue/tree/main/demos/sqlcipher-kv-pair)
40+
- [Mobile Service](https://github.com/ionic-enterprise/tutorials-and-demos-vue/blob/main/demos/sqlcipher-kv-pair/src/composables/mobile-kv-store.ts)
41+
- [Web Service](https://github.com/ionic-enterprise/tutorials-and-demos-vue/blob/main/demos/sqlcipher-kv-pair/src/composables/web-kv-store.ts)
42+
43+
## Other Options
44+
45+
Other storage options that provide local as well as cloud-based storage that work well within Capacitor applications also exist and may integrate well with your application.
46+
47+
For example:
48+
49+
- [PouchDB](https://pouchdb.com/)
50+
- [Firestore](https://firebase.google.com/docs/firestore)

versioned_docs/version-v7/angular/storage.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,44 @@ sidebar_label: Storage
77
<title>Angular App Data Storage Options - Ionic Documentation</title>
88
<meta
99
name="description"
10-
content="A variety of options are available for storing data within Ionic apps made using Angular. Read our documentation for Ionic Secure Storage and @ionic/storage."
10+
content="A variety of options are available for storing data within Ionic apps made using Angular. Choose the options that best fit your storage needs."
1111
/>
1212
</head>
1313

14-
There are variety of options available for storing data within an Ionic app.
14+
There are a variety of options available for storing data within an Ionic application. It is best to choose options that best fit the needs of your application. A single application may have requirements that span multiple options.
1515

16-
Here are two official Ionic options:
16+
:::info
17+
Some storage options involve third-party plugins or products. In such cases, we neither endorse nor support those plugins or products. We are mentioning them here for informational purposes only.
18+
:::
1719

18-
## Ionic Secure Storage
20+
Here are some common use cases and solutions:
1921

20-
For teams building mission-critical apps or requiring encryption support, [Ionic Secure Storage](https://ionic.io/docs/secure-storage) is an official premium solution from the Ionic team that provides a cross-platform data storage system that works on iOS and Android.
22+
## Local Application Settings and Data
2123

22-
It makes it easy to build high performance, offline-ready Ionic apps across iOS, Android, and the web.
24+
Many applications need to locally store settings as well as other lightweight key/value data. The [Capacitor Preferences](https://capacitorjs.com/docs/apis/preferences) plugin is specifically designed to handle these scenarios.
2325

24-
[Learn more](https://ionic.io/products/secure-storage)
26+
## Relational Data Storage (Mobile Only)
2527

26-
## @ionic/storage
28+
Some applications, especially those following an offline-first methodology, may require locally storing high volumes of complex relational data. For such scenarios, a SQLite plugin may be used. The most common SQLite plugin offerings are:
2729

28-
For developers not requiring encryption nor relational data support, [@ionic/storage](https://github.com/ionic-team/ionic-storage) is an open source key/value API for building apps that work across storage engines on multiple platforms.
30+
- [Cordova SQLite Storage](https://github.com/storesafe/cordova-sqlite-storage) (a [convenience wrapper](https://danielsogl.gitbook.io/awesome-cordova-plugins/sqlite) also exists for this plugin to aid in implementation)
31+
- [Capacitor Community SQLite Plugin](https://github.com/capacitor-community/sqlite)
2932

30-
Additionally, Ionic Secure Storage has a driver that works with the key/value API in `@ionic/storage` while providing encryption and SQLite support.
33+
## Non-Relational High Volume Data Storage (Mobile and Web)
3134

32-
Learn more about [@ionic/storage](https://github.com/ionic-team/ionic-storage)
35+
For applications that need to store a high volume of data as well as operate on both web and mobile, a potential solution is to create a key/value pair data storage service that uses [indexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) on the web and one of the previously mentioned SQLite plugins on mobile.
36+
37+
Here a sample of how this can be accomplished:
38+
39+
- [Full application](https://github.com/ionic-enterprise/tutorials-and-demos-ng/tree/main/demos/sqlcipher-kv-pair)
40+
- [Mobile Service](https://github.com/ionic-enterprise/tutorials-and-demos-ng/blob/main/demos/sqlcipher-kv-pair/src/app/core/mobile-kv-store.ts)
41+
- [Web Service](https://github.com/ionic-enterprise/tutorials-and-demos-ng/blob/main/demos/sqlcipher-kv-pair/src/app/core/web-kv-store.ts)
42+
43+
## Other Options
44+
45+
Other storage options that provide local as well as cloud-based storage that work well within Capacitor applications also exist and may integrate well with your application.
46+
47+
For example:
48+
49+
- [PouchDB](https://pouchdb.com/)
50+
- [Firestore](https://firebase.google.com/docs/firestore)
Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,50 @@
11
---
2+
title: Data Storage
23
sidebar_label: Storage
34
---
45

5-
# Data Storage
6+
<head>
7+
<title>React App Data Storage Options - Ionic Documentation</title>
8+
<meta
9+
name="description"
10+
content="A variety of options are available for storing data within Ionic apps made using React. Choose the options that best fit your storage needs."
11+
/>
12+
</head>
613

7-
There are variety of options available for storing data within an Ionic app.
14+
There are a variety of options available for storing data within an Ionic application. It is best to choose options that best fit the needs of your application. A single application may have requirements that span multiple options.
815

9-
Here are two official Ionic options:
16+
:::info
17+
Some storage options involve third-party plugins or products. In such cases, we neither endorse nor support those plugins or products. We are mentioning them here for informational purposes only.
18+
:::
1019

11-
## Ionic Secure Storage
20+
Here are some common use cases and solutions:
1221

13-
For teams building mission-critical apps or requiring encryption support, [Ionic Secure Storage](https://ionic.io/docs/secure-storage) is an official premium solution from the Ionic team that provides a cross-platform data storage system that works on iOS and Android.
22+
## Local Application Settings and Data
1423

15-
It makes it easy to build high performance, offline-ready Ionic apps across iOS, Android, and the web.
24+
Many applications need to locally store settings as well as other lightweight key/value data. The [Capacitor Preferences](https://capacitorjs.com/docs/apis/preferences) plugin is specifically designed to handle these scenarios.
1625

17-
[Learn more](https://ionic.io/products/secure-storage)
26+
## Relational Data Storage (Mobile Only)
1827

19-
## @ionic/storage
28+
Some applications, especially those following an offline-first methodology, may require locally storing high volumes of complex relational data. For such scenarios, a SQLite plugin may be used. The most common SQLite plugin offerings are:
2029

21-
For developers not requiring encryption nor relational data support, [@ionic/storage](https://github.com/ionic-team/ionic-storage) is an open source key/value API for building apps that work across storage engines on multiple platforms.
30+
- [Cordova SQLite Storage](https://github.com/storesafe/cordova-sqlite-storage) (a [convenience wrapper](https://danielsogl.gitbook.io/awesome-cordova-plugins/sqlite) also exists for this plugin to aid in implementation)
31+
- [Capacitor Community SQLite Plugin](https://github.com/capacitor-community/sqlite)
2232

23-
Additionally, Ionic Secure Storage has a driver that works with the key/value API in `@ionic/storage` while providing encryption and SQLite support.
33+
## Non-Relational High Volume Data Storage (Mobile and Web)
2434

25-
Learn more about [@ionic/storage](https://github.com/ionic-team/ionic-storage)
35+
For applications that need to store a high volume of data as well as operate on both web and mobile, a potential solution is to create a key/value pair data storage service that uses [indexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) on the web and one of the previously mentioned SQLite plugins on mobile.
36+
37+
Here a sample of how this can be accomplished:
38+
39+
- [Full application](https://github.com/ionic-enterprise/tutorials-and-demos-react/tree/main/demos/sqlcipher-kv-pair)
40+
- [Mobile Service](https://github.com/ionic-enterprise/tutorials-and-demos-react/blob/main/demos/sqlcipher-kv-pair/src/utils/mobile-kv-store.ts)
41+
- [Web Service](https://github.com/ionic-enterprise/tutorials-and-demos-react/blob/main/demos/sqlcipher-kv-pair/src/utils/web-kv-store.ts)
42+
43+
## Other Options
44+
45+
Other storage options that provide local as well as cloud-based storage that work well within Capacitor applications also exist and may integrate well with your application.
46+
47+
For example:
48+
49+
- [PouchDB](https://pouchdb.com/)
50+
- [Firestore](https://firebase.google.com/docs/firestore)

0 commit comments

Comments
 (0)