docs/net.corda.core.schemas

Package-level declarations

Types

CommonSchema

object CommonSchema

JPA representation of the common schema entities

CommonSchemaV1

object CommonSchemaV1 : MappedSchema

First version of the Vault ORM schema

DirectStatePersistable

interface DirectStatePersistable : StatePersistable

Marker interface to denote a persistable Corda state entity that exposes the transaction id and index as composite key called stateRef.

IndirectStatePersistable

interface IndirectStatePersistable<T : DirectStatePersistable> : StatePersistable

Marker interface to denote a persistable Corda state entity that exposes the transaction id and index as a nested composite key called compositeKey that is itself a DirectStatePersistable. i.e. exposes a stateRef.

MappedSchema

open class MappedSchema(schemaFamily: Class<*>, val version: Int, val mappedTypes: Iterable<Class<*>>)

A database schema that might be configured for this node. As well as a name and version for identifying the schema, also list the classes that may be used in the generated object graph in order to configure the ORM tool.

MappedSchemaValidator

object MappedSchemaValidator

PersistentState

open class PersistentState(var stateRef: PersistentStateRef? = null) : DirectStatePersistable

A super class for all mapped states exported to a schema that ensures the StateRef appears on the database row. The StateRef will be set to the correct value by the framework (there's no need to set during mapping generation by the state itself).

PersistentStateRef

data class PersistentStateRef(var txId: String, var index: Int) : Serializable

Embedded StateRef representation used in state mapping.

QueryableState

interface QueryableState : ContractState

A contract state that may be mapped to database schemas configured for this node to support querying for, or filtering of, states.

StatePersistable

interface StatePersistable

Marker interface to denote a persistable Corda state entity that will always have a transaction id and index