Skip to content

Commit 93c1619

Browse files
authored
docs: add Parse ObjC SDK migration guide (#392)
1 parent 48bec30 commit 93c1619

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

MIGRATION.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Migration from Parse ObjC SDK <!-- omit in toc -->
2+
3+
This document describes how to migrate from the [Parse ObjC SDK](https://github.com/parse-community/Parse-SDK-iOS-OSX) to the Parse Swift SDK.
4+
5+
ℹ️ *This document is a work-in-progress. If you find information missing, please submit a pull request to help us updating this document for the benefit of others.*
6+
7+
- [Status of the SDKs](#status-of-the-sdks)
8+
- [Migration Instructions](#migration-instructions)
9+
- [Behavioral Differences](#behavioral-differences)
10+
- [Known Issues](#known-issues)
11+
- [Feature Comparison](#feature-comparison)
12+
13+
# Status of the SDKs
14+
15+
The Parse ObjC SDK will be phased out in the future in favor of the more modern Parse Swift SDK. While both SDKs overlap in the ecosystems they serve, they are built conceptually different, which can make migration more challenging. Your milage may vary depending on your use case, we therefore encourage you to migrate as soon as possible.
16+
17+
# Migration Instructions
18+
19+
1. x
20+
2. x
21+
3. x
22+
23+
# Behavioral Differences
24+
25+
- x
26+
- x
27+
- x
28+
29+
# Known Issues
30+
31+
The issues below are important to consider before migrating.
32+
33+
- ⚠️ Partially updating an object sends the full object to the server; this can have a significant impact on data transfer costs depending on your use case and architecture. All other Parse SDKs including the Parse ObjC SDK only send the changed properties to the server. For details see [GitHub issue #242](https://github.com/parse-community/Parse-Swift/issues/242).
34+
35+
# Feature Comparison
36+
37+
This table only lists features that are known to be available in the Parse ObjC SDK but still missing in the Swift SDK. *This table is a work-in-progress.*
38+
39+
| Feature | Parse ObjC SDK | Parse Swift SDK |
40+
|---------|----------------|-----------------|
41+
| - | - | - |

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ To learn how to use or experiment with ParseSwift, you can run and edit the [Par
4040
- [SwiftUI View Models Using Combine](#swiftui-view-models-using-combine)
4141
- [Traditional Callbacks](#traditional-callbacks)
4242
- [Advanced Usage](#advanced-usage)
43+
- [Migration from Parse ObjC SDK](#migration-from-parse-objc-sdk)
4344

4445
## Installation
4546

@@ -241,3 +242,7 @@ You are not limited to a single Live Query Client - you can create multiple inst
241242
[docs]: https://docs.parseplatform.org
242243
[license-link]: LICENSE
243244
[open-collective-link]: https://opencollective.com/parse-server
245+
246+
## Migration from Parse ObjC SDK
247+
248+
See the [Migration Guide](MIGRATION.md) to help you migrate from the Parse ObjC SDK.

0 commit comments

Comments
 (0)