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.
Unless specified otherwise the node tables are for internal use and can change between versions.
Some tables, especially the ones where the Ledger is maintained, are append-only and the data will never change.
Manually adding, removing or updating any data should only be done with great care. Corda is a distributed ledger and modifying
data could lead to unexpected behaviour and inconsistent views of the ledger.
These are tables that store the node info 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.
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 CorDapp identities and Node services.
NODE_IDENTITIES
Maps a public key hash to an identity.
PK_HASH
The public key hash.
IDENTITY_VALUE
The certificate chain.
NODE_NAMED_IDENTITIES
Maps the X500 name of a participant to a public key hash.
NAME
The x500 name.
PK_HASH
The public key hash.
NODE_IDENTITIES_NO_CERT
Maps a public key hash to the X500 name of a participant.
Read more in 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_PARAMETERS
Stores the downloaded network parameters.
HASH
The hash of the downloaded file. Used as a primary key.
EPOCH
The version of the parameters
PARAMETERS_BYTES
The serialized bytes
SIGNATURE_BYTES
The signature
CERT
First signer certificate in the certificate chain.
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_TRANSACTIONS
Corda transactions in a binary format
TX_ID
The hash of the transaction. Primary key.
TRANSACTION_VALUE
The binary representation of the transaction.
STATE_MACHINE_RUN_ID
The flow id associated with this transaction.
STATUS
VERIFIED or UNVERIFIED
TIMESTAMP
The insert or status update time of this transaction, as measured by the local node, in UTC.
The columns PRIVATE_KEY_MATERIAL_WRAPPED and SCHEME_CODE_NAME are populated, instead of the column PRIVATE_KEY,
if an HSM is configured for anonymous identities. For more details about this feature, read Using an HSM with confidential identities.
PK_HASH_TO_EXT_ID_MAP
Maps public keys to external ids. Mainly used by CorDapps that need to simulate accounts.
Whether the checkpoint is compatible with the current CorDapps/Corda version
PROGRESS_STEP
The progress step that the flow reached
FLOW_IO_REQUEST
The request type the flow suspended on
TIMESTAMP
The timestamp
NODE_CHECKPOINT_BLOBS
Stores serialized flow checkpoint blobs
FLOW_ID
Primary key
CHECKPOINT_VALUE
Serialized information about the flow
FLOW_STATE
Serialized application stack
TIMESTAMP
The timestamp
NODE_FLOW_RESULTS
Stores results of flows
FLOW_ID
Primary key
RESULT_VALUE
Serialized result of the flow
TIMESTAMP
The timestamp
NODE_FLOW_EXCEPTIONS
Stores exceptions thrown by flows
FLOW_ID
Primary key
TYPE
The class name of the exception
EXCEPTION_MESSAGE
The message of the exception
STACK_TRACE
The stack trace of the exception
EXCEPTION_VALUE
Serialized exception thrown by the flow
TIMESTAMP
The timestamp
NODE_FLOW_METADATA
Stores exceptions thrown by flows
FLOW_ID
Primary key
INVOCATION_ID
The invocation id of the flow
FLOW_NAME
The class name of the flow
FLOW_IDENTIFIER
The identifier of the flow
STARTED_TYPE
How the flow was started
FLOW_PARAMETERS
The parameters the flow was started with
CORDAPP_NAME
The name of the CorDapp that contains the flow
PLATFORM_VERSION
The platform version at the start time of the flow
STARTED_BY
The RPC user that started the flow
INVOCATION_TIME
The time the flow was originally invoked by RPC
START_TIME
The time the flow started inside the state machine
FINISH_TIME
The 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 empty. Read more in Upgrading deployed CorDapps.
NODE_MESSAGE_IDS
Used for de-duplication of messages received by peers.
MESSAGE_ID
Message id
INSERTION_TIME
Insertion time
SENDER
P2p sender
SEQUENCE_NUMBER
Sequence number
The NodeJanitor is a background process that will clean up old entries from this table.
The size should be fairly constant.
Note that the vault tables are guaranteed to remain backwards compatible and are safe to be used directly by third party applications.
VAULT_STATES
Principal vault table.
OUTPUT_INDEX
Reference to a state - index in transaction
TRANSACTION_ID
Reference to a state - transaction id
CONSUMED_TIMESTAMP
When the state was consumed.
CONTRACT_STATE_CLASS_NAME
Contract class
LOCK_ID
The soft lock id
LOCK_TIMESTAMP
The soft lock timestamp
NOTARY_NAME
The notary
RECORDED_TIMESTAMP
Recorded timestamp
STATE_STATUS
CONSUMED or UNCONSUMED
RELEVANCY_STATUS
RELEVANT or NOT_RELEVANT
CONSTRAINT_TYPE
The contract constraint.
CONSTRAINT_DATA
The hash or the composite key depending on the CONSTRAINT_TYPE
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_NOTES
Allows additional notes per transaction
SEQ_NO
Primary key
TRANSACTION_ID
The transaction
NOTE
The note
STATE_PARTY
Maps participants to states
OUTPUT_INDEX
Reference to a state - index in transaction
TRANSACTION_ID
Reference to a state - transaction id
PUBLIC_KEY_HASH
The pk of the participant
X500_NAME
The name of the participant or null if unknown.
V_PKEY_HASH_EX_ID_MAP
This is a database view used to map states to external ids.
Metering data recorded for signing events on this node
TIMESTAMP
The time in UTC, to the nearest hour, that the metering count was recorded
SIGNING_ID
An external identifier that signed a transaction, or UNMAPPED_IDENTITY
TRANSACTION_TYPE
Whether this was a normal transaction, a contract upgrade, a notary change, or an indication that signing events were discarded due to heavy memory use or restarting a node
CORDAPP_STACK_ID
An identifier linking to the NODE_METERING_CORDAPPS table
COMMAND_ID
An identifier linking to the NODE_METERING_COMMANDS table
COUNT
The total number of events in this window with the above characteristics
IS_COLLECTED
Whether these counts have been gathered by collection tooling
VERSION
The platform version at which this data was recorded
NODE_METERING_CORDAPPS
A record of what CorDapps were involved in signing events
STACK_HASH
An identifier for the set of CorDapps involved in a signing event
CORDAPP_HASH
The JAR hash of one CorDapp involved in the signing event
POSITION
The position in the stack this CorDapp was present at
ID
A unique identifier for this row
NODE_METERING_COMMANDS
A record of what commands were on a transaction that has been metered
COMMAND_HASH
An identifier for the set of commands on a transaction
COMMAND_CLASS
The class name of a command in the set
ID
A unique identifier for this row
NODE_CORDAPP_METADATA
Metadata about CorDapps that have been installed on the node
RPC actions play a vital part in the process of triggering commands and flows on a node. In a variety of cases you will need to track the usage of RPC actions - for example, when there are security and regulatory concerns. To do so, you can use the Corda Enterprise node’s capability to record audit information about RPC actions as they are received, prior to executing each action.
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.
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.
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.
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.
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.
