Resources / GraphDatabase

GraphDatabase

A distributed graph database you query with openCypher over Bolt or HTTP, from a VPC. Its data is divided into regions kept in Etorm storage; its servers sleep when idle, so an idle database costs only its storage. You pay for the storage it holds and the processor time it uses. The password is shown once, when the database is created.

Overview

APIgraphdatabase.etorm.com/v1alpha1
Resourcegraphdatabases (cluster-scoped inside its cluster)
Short namesgdb
Available inproject clusters only
Statuswritten by a controller through /status

Minimal example

apiVersion: graphdatabase.etorm.com/v1alpha1
kind: GraphDatabase
metadata:
  name: example
spec:
  vpcRef:
    name: "<name>"

Spec

FieldTypeRequiredDefaultAllowedDescription
vpcRefreference to VPCyesThe VPC the database's endpoints are on. Cannot be changed.
sizeClassstring (one of)"auto"auto, small, medium, largeHow many servers the database may use at most: small 2 region servers and 1 query server, medium 8 and 4, large 32 and 16. auto starts small and grows with the data, up to large.
maxRegionsinteger10241 to 100000The most regions (key ranges) the database may be divided into; it stops splitting there.
consistencystring (one of)"strong"strong, boundedstrong: every read sees the latest commit. bounded: reads may be served by followers up to staleSeconds old.
staleSecondsinteger1 to 3600With consistency bounded: how old a read may be, in seconds.
replicasinteger00 to 2Read followers per region. Only 0 is accepted.
backupobjectPoint-in-time snapshots. Reserved: no snapshots are taken.
backup.retainSnapshotsinteger00 to 64How many snapshots to keep.
backup.intervalSecondsintegerat least 60Seconds between snapshots.
userstringup to 63 charactersThe user for password sign-in. Defaults to app. Cannot be changed.
passwordGenerationintegerat least 0Raise it to set a new password for the user: the new password is shown once, in the response to that change, and the old one stops working. It cannot be lowered.
identityAuthbooleantrueAlso accept an Etorm identity's token (needs the graphdatabase-user role on this database).
resourcesobject{}What each server may use.
resources.memoryPowerinteger100 to 12Memory per server: 64 KiB times two to this power (10 is 64 MiB, 12 is 256 MiB, the most a process may have).
resources.cpuMillicoresinteger2501 to 1000Processor time per server on average, in thousandths of a core.

Status

FieldTypeRequiredDefaultAllowedDescription
phasestringPending, Ready, Degraded (serving, with a server down) or Failed.
endpointsobjectWhere to connect.
endpoints.boltobjectThe Bolt endpoint.
endpoints.bolt.addressstringIts IPv6 address on the VPC.
endpoints.bolt.portintegerThe Bolt port, 7687.
endpoints.httpobjectThe HTTP/JSON endpoint.
endpoints.http.addressstringIts IPv6 address on the VPC.
endpoints.http.portintegerThe HTTP port, 7474.
regionsintegerHow many regions the data is divided into now.
serversintegerRegion servers running.
executorsintegerQuery servers running.
storageBytesintegerBytes held in storage now.
timestampintegerThe newest transaction timestamp issued (for support).
epochintegerIncreases every time a new placement driver takes over.
usageobjectWhat it has used, as billed: processor time and the bytes it holds now.
usage.cpuSecondsnumberCPU time used since `since`, in seconds.
usage.storageBytesintegerBytes it holds now (billed as GiB-seconds while they are held).
usage.sincestringWhen metering started (RFC 3339).
usage.fuelTotalintegerInternal: all fuel counted so far (2 000 000 000 per CPU-second).
usage.fuelSeenobjectInternal: the last fuel count seen per server.
passwordVerifierstringThe salted verifier of the user's password (SCRAM-SHA-256), never the password.
passwordstringThe user's password: present only in the response that created the database, never stored.
conditionslist of objectDetailed state, one entry per aspect; Ready says whether the database accepts queries.
conditions[].typestringAspect.
conditions[].statusstringTrue or False.
conditions[].reasonstringMachine-readable reason.
conditions[].messagestringHuman-readable detail.

Columns in listings

ColumnFrom
Size.spec.sizeClass
Regions.status.regions
Bolt.status.endpoints.bolt.address
Phase.status.phase
Detail.status.conditions[0].message

All resources