generated: '2026-10-04'
method: derived
generator: derive-data-model.py
source:
- openapi/neo4j-authentication-api-openapi.yml
- openapi/neo4j-discovery-api-openapi.yml
- openapi/neo4j-instances-api-openapi.yml
- openapi/neo4j-query-api-openapi.yml
- openapi/neo4j-snapshots-api-openapi.yml
- openapi/neo4j-tenants-api-openapi.yml
- openapi/neo4j-transactions-api-openapi.yml
notation: has_one = property $ref; has_many = array of $ref; belongs_to = <entity>_id field
summary:
  entities: 22
  entities_in_spec: 22
  relationships: 13
entities:
- name: AuraError
  fields: 1
  description: Error response from the Aura API.
- name: CreateInstanceRequest
  fields: 7
  description: Request body for creating a new AuraDB instance.
- name: CypherStatement
  fields: 4
  description: A single Cypher statement with optional parameters and result format.
- name: DiscoveryResponse
  fields: 5
  description: Server discovery information including available endpoints, version, and connection details.
- name: ErrorResponse
  fields: 2
  description: Response containing one or more errors.
- name: GraphNode
  fields: 3
  description: A node returned in graph result format.
- name: GraphRelationship
  fields: 5
  description: A relationship returned in graph result format.
- name: Instance
  fields: 12
  description: An AuraDB cloud database instance.
- name: InstanceCreated
  fields: 7
  description: Response when an instance is created, including initial credentials.
- name: Neo4jError
  fields: 2
  description: An error returned by the Neo4j server.
- name: OverwriteInstanceRequest
  fields: 2
  description: Request body for overwriting an instance from a snapshot.
- name: QueryRequest
  fields: 1
  description: Request body for executing one or more Cypher statements using an implicit transaction.
- name: QueryResponse
  fields: 2
  description: Response containing query results from an implicit transaction.
- name: QueryStatistics
  fields: 12
  description: Statistics about query execution.
- name: RestoreSnapshotRequest
  fields: 6
  description: Request body for restoring a snapshot to a new instance.
- name: Snapshot
  fields: 5
  description: A point-in-time snapshot of an AuraDB instance.
- name: StatementResult
  fields: 3
  description: Result of a single Cypher statement execution.
- name: Tenant
  fields: 3
  description: A tenant (project) that organizes AuraDB instances.
- name: TokenResponse
  fields: 3
  description: OAuth2 access token response.
- name: TransactionRequest
  fields: 1
  description: Request body for executing Cypher statements within a transaction.
- name: TransactionResponse
  fields: 4
  description: Response from a transaction operation.
- name: UpdateInstanceRequest
  fields: 2
  description: Request body for updating an instance configuration.
relationships:
- from: CreateInstanceRequest
  to: Tenant
  type: belongs_to
  via: tenant_id
- from: Instance
  to: Tenant
  type: belongs_to
  via: tenant_id
- from: InstanceCreated
  to: Tenant
  type: belongs_to
  via: tenant_id
- from: QueryRequest
  to: CypherStatement
  type: has_many
  via: statements
- from: QueryResponse
  to: StatementResult
  type: has_many
  via: results
- from: QueryResponse
  to: Neo4jError
  type: has_many
  via: errors
- from: StatementResult
  to: QueryStatistics
  type: has_one
  via: stats
- from: ErrorResponse
  to: Neo4jError
  type: has_many
  via: errors
- from: RestoreSnapshotRequest
  to: Tenant
  type: belongs_to
  via: tenant_id
- from: Snapshot
  to: Instance
  type: belongs_to
  via: instance_id
- from: TransactionResponse
  to: StatementResult
  type: has_many
  via: results
- from: TransactionResponse
  to: Neo4jError
  type: has_many
  via: errors
- from: TransactionRequest
  to: CypherStatement
  type: has_many
  via: statements