Add support for RealmConfiguration.initialRealmFile()

[sync-by-unito]

Similar to Realm Java we should support shipping bundled Realm files.

Proposed API:

// Path to file...semantics might differ based on target
RealmConfiguration.Builder.assetFile(path: String)

Since bundling files are different across platforms, this might be slightly tricky to do across all platforms, e.g. JAR's don't come with a build-in mechanism.

[cmelchior]

We have seen reports in Realm Java indicating corrupt files in combination with asset files. We cannot definitely point to assetfiles being the root cause of this, but it would make sense to support an overload that accept a checksum of the file, so we can ensure that the file shipped is actually also the file copied from the APK, something like Configuration.assetFile(fileName: String, sha256checkSum: String? = null)

[tinoue]

It the issue still open ?
I haven't tested by myself yet, but it seems like the following document support bundled (asset) realm data."
https://www.mongodb.com/docs/realm/sdk/kotlin/realm-database/realm-files/bundle-a-realm/

[rorbech]

@tinoue Yes, the issue is still open and is currently been worked on. The convention around placing the files in the source project is a bit tricky due to varying conventions on the various platforms, so there is unfortunately no ETA.

The linked docs seems off. I will file an issue to fix that, thanks.