page.corvus.database Documentation (EN)

main object

A database block

Properties

blockId string at-uri Required

The AT-URI of this block record

columns ref page.corvus.core#sequence Optional

The columns of the database, sequence of column block ids

rows ref page.corvus.core#set Optional

The rows of the database

title ref page.corvus.core#sequence Optional

The name of the database

View raw schema

{
  "type": "object",
  "required": [
    "blockId"
  ],
  "properties": {
    "rows": {
      "ref": "page.corvus.core#set",
      "type": "ref",
      "description": "The rows of the database"
    },
    "title": {
      "ref": "page.corvus.core#sequence",
      "type": "ref",
      "description": "The name of the database"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    },
    "columns": {
      "ref": "page.corvus.core#sequence",
      "type": "ref",
      "description": "The columns of the database, sequence of column block ids"
    }
  },
  "description": "A database block"
}

atLink object

A link to an ATProtocol resource

Properties

blockId string at-uri Required

The AT-URI of this block record

uri string at-uri Required

The AT-URI of the linked resource

View raw schema

{
  "type": "object",
  "required": [
    "blockId",
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of the linked resource"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    }
  },
  "description": "A link to an ATProtocol resource"
}

cell object

No description available.

Properties

columnId string at-uri Optional

The id of the column this cell belongs to

valueBlockId string at-uri Optional

The id of the value block

View raw schema

{
  "type": "object",
  "properties": {
    "columnId": {
      "type": "string",
      "format": "at-uri",
      "description": "The id of the column this cell belongs to"
    },
    "valueBlockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The id of the value block"
    }
  }
}

column object

A database column

Properties

blockId string at-uri Required

The AT-URI of this block record

cellType string nsid Optional

The type of the column

Known values: page.corvus.document#prose, page.corvus.contentBlocks#checkbox, page.corvus.contentBlocks#code, page.corvus.contentBlocks#image, page.corvus.contentBlocks#atLink, page.corvus.contentBlocks#blockLink

defaults ref page.corvus.core#set Optional

The default properties for the column

name ref page.corvus.core#register Optional

The title of the column

View raw schema

{
  "type": "object",
  "required": [
    "blockId"
  ],
  "properties": {
    "name": {
      "ref": "page.corvus.core#register",
      "type": "ref",
      "description": "The title of the column"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    },
    "cellType": {
      "type": "string",
      "format": "nsid",
      "description": "The type of the column",
      "knownValues": [
        "page.corvus.document#prose",
        "page.corvus.contentBlocks#checkbox",
        "page.corvus.contentBlocks#code",
        "page.corvus.contentBlocks#image",
        "page.corvus.contentBlocks#atLink",
        "page.corvus.contentBlocks#blockLink"
      ]
    },
    "defaults": {
      "ref": "page.corvus.core#set",
      "type": "ref",
      "description": "The default properties for the column"
    }
  },
  "description": "A database column"
}

columnReferenceFacet object

No description available.

Properties

columnId string at-uri Optional

The id of the column this reference belongs to

View raw schema

{
  "type": "object",
  "properties": {
    "columnId": {
      "type": "string",
      "format": "at-uri",
      "description": "The id of the column this reference belongs to"
    }
  }
}

counter object

No description available.

Properties

blockId string at-uri Required

The AT-URI of this block record

count ref page.corvus.core#counter Optional

The counter value

View raw schema

{
  "type": "object",
  "required": [
    "blockId"
  ],
  "properties": {
    "count": {
      "ref": "page.corvus.core#counter",
      "type": "ref",
      "description": "The counter value"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    }
  }
}

databaseReferenceFacet object

No description available.

Properties

databaseId string at-uri Optional

The id of the database this reference belongs to

View raw schema

{
  "type": "object",
  "properties": {
    "databaseId": {
      "type": "string",
      "format": "at-uri",
      "description": "The id of the database this reference belongs to"
    }
  }
}

row object

A database row

Properties

blockId string at-uri Required

The AT-URI of this block record

cells ref page.corvus.core#set Optional

The cells of the row, one per column with a value

View raw schema

{
  "type": "object",
  "required": [
    "blockId"
  ],
  "properties": {
    "cells": {
      "ref": "page.corvus.core#set",
      "type": "ref",
      "description": "The cells of the row, one per column with a value"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    }
  },
  "description": "A database row"
}

sql object

No description available.

Properties

blockId string at-uri Required

The AT-URI of this block record

facets ref page.corvus.core#set Optional

The facets applied to the SQL query

text ref page.corvus.core#sequence Optional

The SQL query text

View raw schema

{
  "type": "object",
  "required": [
    "blockId"
  ],
  "properties": {
    "text": {
      "ref": "page.corvus.core#sequence",
      "type": "ref",
      "description": "The SQL query text"
    },
    "facets": {
      "ref": "page.corvus.core#set",
      "type": "ref",
      "description": "The facets applied to the SQL query"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    }
  }
}

sqlReferenceFacet object

No description available.

Properties

sqlId string at-uri Optional

The id of the SQL query this reference belongs to

View raw schema

{
  "type": "object",
  "properties": {
    "sqlId": {
      "type": "string",
      "format": "at-uri",
      "description": "The id of the SQL query this reference belongs to"
    }
  }
}

string object

No description available.

Properties

blockId string at-uri Required

The AT-URI of this block record

text ref page.corvus.core#register Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "blockId"
  ],
  "properties": {
    "text": {
      "ref": "page.corvus.core#register",
      "type": "ref"
    },
    "blockId": {
      "type": "string",
      "format": "at-uri",
      "description": "The AT-URI of this block record"
    }
  }
}