R3 Docs R3 Docs Home

Database tables

A Corda node database contains tables corresponding to the various services that the node provides. It also contains custom tables defined by the CorDapps that are installed on the node. Currently all these tables share the same database schema, but in a future release they will be isolated from each other.

Some tables, especially the ones where the Ledger is maintained are append-only and the data will never change.

These are tables that store the NodeInfo of other network participants. They are just a local cache that is kept in sync with the network map server. By calling rpc.clearNetworkMapCache() all these tables will be cleared and recreated from the network map server.

Read more here: The network map

node info tables
NODE_INFOSStores NodeInfo objects. The principal table.
NODE_INFO_IDPrimary key
NODE_INFO_HASHHash of the binary nodeInfo file
PLATFORM_VERSIONDeclared version of the participant node.
SERIALVersion of the NodeInfo
NODE_INFO_HOSTSMany-to-one addresses to node
HOSTS_IDPrimary key
HOST_NAMEHost name of the participant’s node
PORTPort
NODE_INFO_IDFK to NODE_INFOS
NODE_INFO_PARTY_CERTLegal identity for a network participant
PARTY_NAMEThe X500 name
OWNING_KEY_HASHThe public key
ISMAINIf this is a main identity
PARTY_CERT_BINARYThe certificate chain
NODE_LINK_NODEINFO_PARTYMany-to-Many link between the hosts and the legal identities
NODE_INFO_IDFK to Node_info
PARTY_NAMEFK to NODE_INFO_PARTY_CERT

The following four tables are used by the IdentityService and are created from the NodeInfos. They are append only tables used for persistent caching. They will also be cleared on rpc.clearNetworkMapCache(). Read more in API: Identity and Node services

NODE_IDENTITIESMaps a public key hash to an identity.
PK_HASHThe public key hash.
IDENTITY_VALUEThe certificate chain.
NODE_NAMED_IDENTITIESMaps the X500 name of a participant to a public key hash.
NAMEThe x500 name.
PK_HASHThe public key hash.
NODE_IDENTITIES_NO_CERTMaps a public key hash to the X500 name of a participant.
PK_HASHThe public key hash.
NAMEThe x500 name.
NODE_HASH_TO_KEYMaps a public key hash to a public key.
PK_HASHThe public key hash.
PUBLIC_KEYThe public key.

Read more here: The network map. Each downloaded network parameters file will create an entry in this table. The historical network parameters are used when validating transactions, which makes this table logically part of the Ledger. It is an append only table and the size will be fairly small.

NODE_NETWORK_PARAMETERSStores the downloaded network parameters.
HASHThe hash of the downloaded file. Used as a primary key.
EPOCHThe version of the parameters
PARAMETERS_BYTESThe serialized bytes
SIGNATURE_BYTESThe signature
CERTFirst signer certificate in the certificate chain.
PARENT_CERT_PATHParent certificate path of signer.

The ledger data is formed of transactions and attachments. In future versions this data will be encrypted using SGX. Read more in the ledger

Read more in Working with attachments and Node services

attachments tables
NODE_ATTACHMENTSStores attachments
ATT_IDThe hash of the content of the file.
CONTENTThe binary content
FILENAMENot used at the moment.
INSERTION_DATEDate.
UPLOADEROne of: p2p, app, rpc, unknown. Currently used for for determining if this attachment is safe to execute during transaction verification.
VERSIONThe version of the JAR file.
NODE_ATTACHMENTS_CONTRACTSMany-to-one contracts per attachment. Empty for non-contract attachments.
ATT_IDForeign key
CONTRACT_CLASS_NAMEThe fully qualified contract class name. E.g.: net.corda.finance.contracts.asset.Cash
NODE_ATTACHMENTS_SIGNERSMany-to-one JAR signers of an attachment. Empty if not signed.
ATT_IDForeign key
SIGNERHex encoded public key of the JAR signer.

These are all the transactions that the node has created or has ever downloaded as part of transaction resolution. This table can grow very large. It is an append-only table, and the data will never change. Read more in Node services - DBTransactionStorage This is the key ledger table used as a source of truth. In the future the content will be encrypted to preserve confidentiality.

NODE_TRANSACTIONSCorda transactions in a binary format
TX_IDThe hash of the transaction. Primary key.
TRANSACTION_VALUEThe binary representation of the transaction.
STATE_MACHINE_RUN_IDThe flow id associated with this transaction.
STATUSVERIFIED or UNVERIFIED
NODE_CONTRACT_UPGRADESRepresents an authorisation to upgrade a state_ref to a contract.
STATE_REFThe authorised state.
CONTRACT_CLASS_NAMEThe contract.

This table should be empty when no states are authorised for upgrade or after authorised states have been upgraded.

NODE_SCHEDULED_STATESContains scheduled states
OUTPUT_INDEXReference to a state - index in transaction
TRANSACTION_IDReference to a state - transaction id
SCHEDULED_ATTimestamp when this state will execute.

This table should be empty when no events are scheduled.

NODE_OUR_KEY_PAIRSStores the anonymous identities
PUBLIC_KEY_HASHPrimary key
PRIVATE_KEYBinary private key
PUBLIC_KEYBinary public key
PK_HASH_TO_EXT_ID_MAPMaps public keys to external ids. Mainly used by CorDapps that need to simulate accounts.
EXTERNAL_IDExternal id
PUBLIC_KEY_HASHPublic key hash

These tables should be append only.

Read more in Node services

NODE_CHECKPOINTSStores high-level information about checkpoints
FLOW_IDPrimary key
STATUSThe status of the flow
COMPATIBLEWhether the checkpoint is compatible with the current CorDapps/Corda version
PROGRESS_STEPThe progress step that the flow reached
FLOW_IO_REQUESTThe request type the flow suspended on
TIMESTAMPThe timestamp
NODE_CHECKPOINT_BLOBSStores serialized flow checkpoint blobs
FLOW_IDPrimary key
CHECKPOINT_VALUESerialized information about the flow
FLOW_STATESerialized application stack
TIMESTAMPThe timestamp
NODE_FLOW_RESULTSStores results of flows
FLOW_IDPrimary key
RESULT_VALUESerialized result of the flow
TIMESTAMPThe timestamp
NODE_FLOW_EXCEPTIONSStores exceptions thrown by flows
FLOW_IDPrimary key
TYPEThe class name of the exception
EXCEPTION_MESSAGEThe message of the exception
STACK_TRACEThe stack trace of the exception
EXCEPTION_VALUESerialized exception thrown by the flow
TIMESTAMPThe timestamp
NODE_FLOW_METADATAStores exceptions thrown by flows
FLOW_IDPrimary key
INVOCATION_IDThe invocation id of the flow
FLOW_NAMEThe class name of the flow
FLOW_IDENTIFIERThe identifier of the flow
STARTED_TYPEHow the flow was started
FLOW_PARAMETERSThe parameters the flow was started with
CORDAPP_NAMEThe name of the CorDapp that contains the flow
PLATFORM_VERSIONThe platform version at the start time of the flow
STARTED_BYThe RPC user that started the flow
INVOCATION_TIMEThe time the flow was originally invoked by RPC
START_TIMEThe time the flow started inside the state machine
FINISH_TIMEThe finish time of the flow

These tables will see the most intense read-write activity, especially NODE_CHECKPOINTS and NODE_CHECKPOINT_BLOBS. Depending on the installed flows and the traffic on the node the I/O operations on this table will be the main bottleneck of the node performance. There will be an entry for every running flow. Draining the node means waiting for this table to become emtpy. Read more in: Upgrading CorDapps on a node.

NODE_MESSAGE_IDSUsed for de-duplication of messages received by peers.
MESSAGE_IDMessage id
INSERTION_TIMEInsertion time
SENDERP2p sender
SEQUENCE_NUMBERSequence number
NODE_PROPERTIESGeneral key value store. Currently only used for the flow draining mode.
PROPERTY_KEYThe key
PROPERTY_VALUEThe value

Read more about the vault here Vault.

Note that the vault tables are guaranteed to remain backwards compatible and are safe to be used directly by third party applications.

VAULT_STATESPrincipal vault table.
OUTPUT_INDEXReference to a state - index in transaction
TRANSACTION_IDReference to a state - transaction id
CONSUMED_TIMESTAMPWhen the state was consumed.
CONTRACT_STATE_CLASS_NAMEContract class
LOCK_IDThe soft lock id
LOCK_TIMESTAMPThe soft lock timestamp
NOTARY_NAMEThe notary
RECORDED_TIMESTAMPRecorded timestamp
STATE_STATUSCONSUMED or UNCONSUMED
RELEVANCY_STATUSRELEVANT or NOT_RELEVANT
CONSTRAINT_TYPEThe contract constraint.
CONSTRAINT_DATAThe hash or the composite key depending on the CONSTRAINT_TYPE
CONSUMING_TX_IDWhen a state is consumed by a transaction, the ID of the consuming transaction is added to this column.

The VAULT_STATES table contains an entry for every relevant state. This table records the status of states and allows CorDapps to soft lock states it intends to consume. Depending on the installed CorDapps this table can grow. For example when fungible states are used.

In case this table grows too large, the DBA can choose to archive old consumed states. The actual content of the states can be retrieved from the NODE_TRANSACTIONS table by deserializing the binary representation.

VAULT_TRANSACTION_NOTESAllows additional notes per transaction
SEQ_NOPrimary key
TRANSACTION_IDThe transaction
NOTEThe note
STATE_PARTYMaps participants to states
OUTPUT_INDEXReference to a state - index in transaction
TRANSACTION_IDReference to a state - transaction id
PUBLIC_KEY_HASHThe pk of the participant
X500_NAMEThe name of the participant or null if unknown.
V_PKEY_HASH_EX_ID_MAPThis is a database view used to map states to external ids.
OUTPUT_INDEXReference to a state - index in transaction
TRANSACTION_IDReference to a state - transaction id
PUBLIC_KEY_HASHThe public key of the participant.
EXTERNAL_IDThe external id.
vault fungible states
VAULT_FUNGIBLE_STATESProperties specific to fungible states
OUTPUT_INDEXReference to a state - index in transaction
TRANSACTION_IDReference to a state - transaction id
ISSUER_NAMEIssuer
ISSUER_REFReference number used by the issuer
OWNER_NAMEX500 name of the owner, or null if unknown
QUANTITYThe amount.
VAULT_FUNGIBLE_STATES_PARTSMany-to-one participants to a fungible state
OUTPUT_INDEXReference to a state - index in transaction
TRANSACTION_IDReference to a state - transaction id
PARTICIPANTSX500 name of participant.
vault linear states
VAULT_LINEAR_STATESProperties specific to linear states
OUTPUT_INDEXReference to a state - index in transaction
TRANSACTION_IDReference to a state - transaction id
EXTERNAL_IDThe external id of this linear state.
UUIDThe internal id of this linear state.
VAULT_LINEAR_STATES_PARTSMany-to-one participants to a linear state
OUTPUT_INDEXReference to a state - index in transaction
TRANSACTION_IDReference to a state - transaction id
PARTICIPANTSX500 name of participant.

These are Liquibase proprietary tables used by Corda internally to manage schema change and evolution.

DATABASECHANGELOGRead more: DATABASECHANGELOG
ID
AUTHOR
FILENAME
DATEEXECUTED
ORDEREXECUTED
EXECTYPE
MD5SUM
DESCRIPTION
COMMENTS
TAG
LIQUIBASE
CONTEXTS
LABELS
DEPLOYMENT_ID
DATABASECHANGELOGLOCKRead more: DATABASECHANGELOGLOCK
ID
LOCKED
LOCKGRANTED
LOCKEDBY
Previous
Database access when running H2
Next
Upgrading CorDapps on a node

Was this page helpful?

Thanks for your feedback!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Chat with us
Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

Learn how

We're sorry this page wasn't helpful. Let us know how we can make it better!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Chat with us
Create an issue

Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.

Create a new issue
Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

Learn how