Add get local schema version to the C-API #7873
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nicola-cab
added
no-changelog
no-jira-ticket
|
Opening in Immutable mode can fail catastrophically if it's done while another process is writing to the file, as it doesn't create a read lock. Instead it needs to modify the config to unset the sync config and set |
…rieve_persisted_schema_version
nicola-cab
force-pushed
the
ct/capi_retrieve_persisted_schema_version
branch
from
8023729 to
cd33039
Compare
tgoyne
reviewed
Jul 11, 2024
src/realm.h
Outdated
| /** | ||
| * Get the schema version for this realm at the path. | ||
| * | ||
| * This function cannot fail. |
There was a problem hiding this comment.
This opens (and possibly creates) a Realm file, which can fail.
| } | ||
|
|
||
| return wrap_err([&]() { | ||
| auto realm = new shared_realm{Realm::get_shared_realm(conf)}; |
There was a problem hiding this comment.
There's no reason to wrap this in an extra shared_realm since it isn't returned to the caller.
nicola-cab
force-pushed
the
ct/capi_retrieve_persisted_schema_version
branch
from
cd33039 to
8830dca
Compare
nicola-cab
force-pushed
the
ct/capi_retrieve_persisted_schema_version
branch
from
2f1210b to
fc97025
Compare
Pull Request Test Coverage Report for Build nicola.cabiddu_1845Details
💛 - Coveralls |
clementetb
approved these changes
Jul 14, 2024
5 tasks
|
@tgoyne is it ok to merge the PR? (it needs a changelog entry probably). |
tgoyne
reviewed
Jul 15, 2024
| conf.force_sync_history = true; | ||
| } | ||
|
|
||
| auto realm = new shared_realm{Realm::get_shared_realm(conf)}; |
There was a problem hiding this comment.
No reason to wrap this in a shared_realm
…rieve_persisted_schema_version
nicola-cab
force-pushed
the
ct/capi_retrieve_persisted_schema_version
branch
from
8ceef8b to
45caad4
Compare
tgoyne
approved these changes
Jul 15, 2024
danieltabacaru
approved these changes
Jul 15, 2024
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What, How & Why?
Kotlin uses some heuristic for which is required to know the local schema version, before opening a synchronized realm via
open_async.There is no clear API for reading the local schema version without opening the realm, and most importantly, avoiding opening a synchronized realm (in order to guarantee that no sync code is run).
Opening realm in immutable mode seems a viable and simple approach for achieving that, although it will result in a double opening, if a migration is needed (since it requires opening a synchronized realm in async mode).
Another possible approach is to add a new cnf param that the SDK needs to specify and throw an exception inside
RealmCoordinator::do_get_realmif the new param is set.☑️ ToDos
bindgen/spec.yml, if public C++ API changed