forked from mongodb/docs-realm
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7ea109c
commit a625924
Showing
24 changed files
with
50 additions
and
50 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
4 changes: 2 additions & 2 deletions
4
...api-details/csharp/manage-files/reduce-file-size-compact-method-description.rst
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
4 changes: 2 additions & 2 deletions
4
...udes/api-details/csharp/manage-files/reduce-file-size-on-launch-description.rst
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
You can use the .NET SDK to check the realm file size each time | ||
You can use the .NET SDK to check the file size each time | ||
it is opened by specifying a | ||
:dotnet-sdk:`ShouldCompactDelegate <reference/Realms.RealmConfiguration.ShouldCompactDelegate.html>` | ||
in the configuration. | ||
|
||
If the delegate returns ``true`` -- and the file is not in use -- the realm file | ||
If the delegate returns ``true`` -- and the file is not in use -- the file | ||
is compacted prior to making the instance available. |
12 changes: 6 additions & 6 deletions
12
...s/api-details/dart/manage-files/reduce-file-size-compact-method-description.rst
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,14 @@ | ||
You can compact a realm file by calling :flutter-sdk:`Realm.compact() | ||
You can compact a file by calling :flutter-sdk:`Realm.compact() | ||
<realm/Realm/compact.html>`. This method takes a :flutter-sdk:`Configuration | ||
<topics/Configuration-topic.html>` as an argument. When you use this method, | ||
the device must have enough free space to make a copy of the realm. | ||
the device must have enough free space to make a copy of the database file. | ||
|
||
``Realm.compact()`` obtains an instance of the realm, and opens it to | ||
``Realm.compact()`` obtains an instance of the database, and opens it to | ||
trigger any schema version upgrades, file format upgrades, migration and | ||
initial data callbacks. Upon successfully opening the realm and performing | ||
these operations, this method then compacts the realm. | ||
initial data callbacks. Upon successfully opening the database and performing | ||
these operations, this method then compacts the database file. | ||
|
||
If successful, a call to ``Realm.compact()`` returns ``true``. | ||
|
||
Do not call this method from inside a transaction. You also cannot compact an | ||
open realm. | ||
open database. |
6 changes: 3 additions & 3 deletions
6
...cludes/api-details/dart/manage-files/reduce-file-size-on-launch-description.rst
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
2 changes: 1 addition & 1 deletion
2
...s/api-details/java/manage-files/reduce-file-size-compact-method-description.rst
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
You can remove unused space by compacting the realm file by manually | ||
You can remove unused space by compacting the database file by manually | ||
calling :java-sdk:`compactRealm() | ||
<io/realm/Realm.html#compactRealm-io.realm.RealmConfiguration->`. |
4 changes: 2 additions & 2 deletions
4
...cludes/api-details/java/manage-files/reduce-file-size-on-launch-description.rst
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
.. important:: Compact All Production Applications | ||
|
||
Every production application should implement compacting to | ||
periodically reduce realm file size. | ||
periodically reduce database file size. | ||
|
||
Specify the :java-sdk:`compactOnLaunch() | ||
<io/realm/RealmConfiguration.Builder.html#compactOnLaunch-io.realm.CompactOnLaunchCallback->` | ||
builder option when opening the first connection to a realm in your | ||
builder option when opening the first connection to a database in your | ||
Android application. |
2 changes: 1 addition & 1 deletion
2
...details/javascript/manage-files/reduce-file-size-compact-method-description.rst
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
You can compact a realm file whenever you'd like by calling | ||
You can compact a database file whenever you'd like by calling | ||
the :js-sdk:`compact() <Realm.html#compact>` method. | ||
|
||
The ``compact()`` method will return true if the operation is successful. |
2 changes: 1 addition & 1 deletion
2
...details/javascript/manage-files/reduce-file-size-compacted-copy-description.rst
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
2 changes: 1 addition & 1 deletion
2
.../api-details/javascript/manage-files/reduce-file-size-on-launch-description.rst
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
You can use the Node.js SDK to check the realm file size each time it is opened | ||
You can use the Node.js SDK to check the database file size each time it is opened | ||
by specifying a :js-sdk:`shouldCompact <Realm.html#~Configuration>` function | ||
for the configuration. The following code example shows how to do this: |
2 changes: 1 addition & 1 deletion
2
...api-details/kotlin/manage-files/reduce-file-size-compact-method-description.rst
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
2 changes: 1 addition & 1 deletion
2
...api-details/kotlin/manage-files/reduce-file-size-compacted-copy-description.rst
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
4 changes: 2 additions & 2 deletions
4
...udes/api-details/kotlin/manage-files/reduce-file-size-on-launch-description.rst
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
You can use the Kotlin SDK to compact the realm file each time it is opened | ||
You can use the Kotlin SDK to compact the database file each time it is opened | ||
by setting a callback for the :kotlin-sdk:`compactOnLaunch | ||
<io.realm.kotlin/-configuration/-shared-builder/compact-on-launch.html>` function | ||
for the configuration. When you call ``compactOnLaunch`` for the | ||
configuration, the :kotlin-sdk:`DEFAULT_COMPACT_ON_LAUNCH_CALLBACK | ||
<io.realm.kotlin/-realm/-companion/-d-e-f-a-u-l-t_-c-o-m-p-a-c-t_-o-n_-l-a-u-n-c-h_-c-a-l-l-b-a-c-k.html>` | ||
will trigger if the file is above 50 MB and 50% or more of the space in | ||
the realm file is unused. You can specify custom compaction settings | ||
the database file is unused. You can specify custom compaction settings | ||
when calling ``compactOnLaunch`` depending on your applications needs. | ||
The following code example shows how to do this: |
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
2 changes: 1 addition & 1 deletion
2
.../api-details/swift/manage-files/reduce-file-size-compacted-copy-description.rst
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
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
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