-
Notifications
You must be signed in to change notification settings - Fork 1.8k
DOCSP-53341: Add converted .md docs to source code repo /docs dir for community access #7910
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
cbullinger
merged 3 commits into
realm:main
from
cbullinger:DOCSP-53341-add-java-sdk-docs
Sep 15, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Realm SDK for Java | ||
| Use the Realm SDK for Java to develop Android apps in Java or Kotlin. | ||
| To develop multiplatform apps using Kotlin Multiplatform (KMP), refer to the | ||
| Kotlin SDK. | ||
|
|
||
| ## SDK in Maintenance Mode | ||
| This SDK is in best-effort maintenance mode and **no longer receives | ||
| new development or non-critical bug fixes**. To develop your app with new | ||
| features, use the Kotlin SDK. You can use the Java SDK with the Kotlin SDK. | ||
|
|
||
| ## Develop Apps with the SDK | ||
| Use the SDK's open-source database - Realm - as an object store on the device. | ||
|
|
||
| ### Install the Java SDK | ||
| Use the Gradle build system to | ||
| install the Java SDK in your project. | ||
|
|
||
| ### Define an Object Schema | ||
| Use Java or Kotlin to idiomatically define an object schema. | ||
|
|
||
| ### Open a Database | ||
| The SDK's database - Realm - stores objects in files on your device. | ||
| Or you can open an in-memory database which does not create a file. | ||
| To get started reading and writing data, | ||
| configure and open a database. | ||
|
|
||
| ### Read and Write Data | ||
| Create, read, update, and | ||
| delete objects from the database. | ||
| Use Android-native queries to filter data. | ||
|
|
||
| ### React to Changes | ||
| Live objects mean that your data is always up-to-date. | ||
| You can register a notification handler to watch for changes and perform some | ||
| logic, such as updating your UI. | ||
|
|
||
| ## Examples | ||
|
|
||
| See the [examples/](..examples/) directory. | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't remember the original docs website structure, but this readme seems a bit odd - like it's missing code snippets or some links.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, it's not ideal. this was originally the landing page, stripped of any links to MongoDB docs or the API ref (hosted on mdb)