typo3_schema_lookup

# The table to list the derived columns of, for example "tt_content". Omit to
# list every table TYPO3 derives columns for, with how many each gets.
table: string  # optional

# The table asked about. Null where the call named none and the answer is the
# list of them.
table: string or null
# Columns for a named table, tables for a call that named none. Zero means the
# name is not a TCA table in this installation, never that TYPO3 derives
# nothing.
matchCount: integer  # optional
# One of: installation. installation: its assembled runtime state answered.
answeredBy: string  # optional
# Empty where the call named no table.
columns:  # optional
  - name: string
    # The Doctrine type the core declares it as: integer, string, text,
    # datetime, json, blob.
    type: string
    notnull: boolean
    # The default the core gives it, null where it declares none.
    default: string or number or boolean or null  # optional
    # Length where the type carries one.
    length: integer or null  # optional
# Every table TYPO3 derives columns for. Returned on a call that named none, and
# on one whose name is not among them.
tables:  # optional
  - table: string
    columnCount: integer
    # True where TYPO3 creates the table itself for an MM relation. No
    # ext_tables.sql declares one at all.
    relationTable: boolean
# What the database has for the named table, read from the connection that table
# maps to. Null where the call named no table, or where the tool could not read
# the schema. That is a project that is down, or an installation whose tables
# nobody created.
actual:  # optional
  # Whether the database has the table at all.
  present: boolean
  columns:
    - name: string
      # The Doctrine type the column has, read from the connection.
      type: string
      notnull: boolean
      # The default the column carries, null where it has none.
      default: string or number or boolean or null  # optional
      # Length where the type carries one.
      length: integer or null  # optional
  indexes:
    - name: string
      columns: [string]
      unique: boolean
      primary: boolean
# What TYPO3 would change to make the database match the schema its active
# extensions and its TCA declare. Empty where the two match, and null where the
# tool could not read a schema. Where the call named a table, only that table's
# changes are here.
updates:  # optional
  - # The TYPO3 database connection the change is on.
    connection: string
    # The change type in TYPO3's own vocabulary — create_table, add, change,
    # change_currentValue, drop, drop_table, change_table — which is also the
    # argument `typo3 database:updateschema` takes.
    change: string
    # The tables that change names.
    tables: [string]
unsupported:  # optional
  # One of: no-installation, misconfigured, installation-not-answering.
  # no-installation: nothing to ask from here, and searched says where the
  # discovery looked. misconfigured: the caller named an installation the server
  # could not use, so the discovery searched nothing.
  # installation-not-answering: the discovery found one and its console did not
  # answer. A stopped container or a database with no schema is that state, and
  # it ends without a reinstall.
  cause: string
  # What stopped it, in the words the attempt produced.
  reason: string
  # One of: installed, not-installed, undeclared. The state of the repository
  # the caller stands in, which the cause does not say. installed: packages sit
  # below the root the discovery found, so the caller lacks no install.
  # not-installed: the repository declares TYPO3 and has no packages below it
  # yet, so this call answers once composer install has run. undeclared: nothing
  # in the directories the discovery walked declares TYPO3, so an install here
  # answers nothing. Null where the discovery looked at nothing: a named root
  # the server could not use, or an entrypoint that handed no directory in.
  repositoryState: string or null  # optional
  # What the reason means where the message alone does not say it. A console
  # that starts and then fails on a missing table has a database without a
  # schema, not a broken installation. Empty where the server knows nothing
  # beyond the reason.
  diagnosis: string  # optional
  # Every directory the discovery walked, in order. "Nothing found" and "the
  # server started somewhere else" read the same, and only this list tells them
  # apart. Empty where the discovery never ran.
  searched: [string]
  # The setting the server could not use. Null where the caller set nothing.
  misconfiguration: string or null  # optional
  settings:
    # Environment variable that names the installation root.
    root: string
    # Environment variable that names the console command.
    console: string