Package-level declarations

Core functions and types.

Types

Link copied to clipboard
interface BaseRealm : Versioned

Base class for all Realm instances (Realm and MutableRealm).

Link copied to clipboard

This interface is used to determine if a Realm file should be compacted the first time the file is opened and before the instance is returned.

Link copied to clipboard
interface Configuration

Base configuration options shared between all realm configuration types.

Link copied to clipboard
interface Deleteable

A deleteable is an entity that can be deleted in a write transaction or as part of a migration.

Link copied to clipboard
fun interface InitialDataCallback

This interface is used to write data to a Realm file when the file is first created. It will be used in a way similar to using Realm.writeBlocking.

Link copied to clipboard
data class InitialRealmFileConfiguration(val assetFile: String, val checksum: String?)

Configuration for pre-bundled asset files used as initial state of the realm file.

Link copied to clipboard
data class LogConfiguration(val level: LogLevel, val loggers: List<RealmLogger>)

Configuration for log events created by a Realm instance.

Link copied to clipboard

Represents the writeable state of a Realm file.

Link copied to clipboard
interface Realm : TypedRealm

A Realm instance is the main entry point for interacting with a persisted realm.

Link copied to clipboard

A Realm Configuration defining specific setup and configuration for a Realm instance.

Link copied to clipboard
interface TypedRealm : BaseRealm

A typed realm that can be queried for objects of a specific type.

Link copied to clipboard

Update policy that controls how to handle import of objects with existing primary keys when import them with MutableRealm.copyToRealm and DynamicMutableRealm.copyToRealm.

Link copied to clipboard
interface Versioned
Link copied to clipboard
data class VersionId(val version: Long) : Comparable<VersionId>

A VersionId representing the transactional id of the Realm itself or it's objects.

Functions

Link copied to clipboard

Deletes all objects of the specified class from the Realm.