{"id": "internals:internals-database-introspection", "page": "internals", "ref": "internals-database-introspection", "title": "Database introspection", "content": "The  Database  class also provides properties and methods for introspecting the database. \n                 \n                     \n                         db.name  - string \n                         \n                             The name of the database - usually the filename without the  .db  prefix. \n                         \n                     \n                     \n                         db.size  - integer \n                         \n                             The size of the database file in bytes. 0 for  :memory:  databases. \n                         \n                     \n                     \n                         db.mtime_ns  - integer or None \n                         \n                             The last modification time of the database file in nanoseconds since the epoch.  None  for  :memory:  databases. \n                         \n                     \n                     \n                         db.is_mutable  - boolean \n                         \n                             Is this database mutable, and allowed to accept writes? \n                         \n                     \n                     \n                         db.is_memory  - boolean \n                         \n                             Is this database an in-memory database? \n                         \n                     \n                     \n                         await db.attached_databases()  - list of named tuples \n                         \n                             Returns a list of additional databases that have been connected to this database using the SQLite ATTACH command. Each named tuple has fields  seq ,  name  and  file . \n                         \n                     \n                     \n                         await db.table_exists(table)  - boolean \n                         \n                             Check if a table called  table  exists. \n                         \n                     \n                     \n                         await db.view_exists(view)  - boolean \n                         \n                             Check if a view called  view  exists. \n                         \n                     \n                     \n                         await db.table_names()  - list of strings \n                         \n                             List of names of tables in the database. \n                         \n                     \n                     \n                         await db.view_names()  - list of strings \n                         \n                             List of names of views in the database. \n                         \n                     \n                     \n                         await db.table_columns(table)  - list of strings \n                         \n                             Names of columns in a specific table. \n                         \n                     \n                     \n                         await db.table_column_details(table)  - list of named tuples \n                         \n                             Full details of the columns in a specific table. Each column is represented by a  Column  named tuple with fields  cid  (integer representing the column position),  name  (string),  type  (string, e.g.  REAL  or  VARCHAR(30) ),  notnull  (integer 1 or 0),  default_value  (string or None),  is_pk  (integer 1 or 0). \n                         \n                     \n                     \n                         await db.primary_keys(table)  - list of strings \n                         \n                             Names of the columns that are part of the primary key for this table. \n                         \n                     \n                     \n                         await db.fts_table(table)  - string or None \n                         \n                             The name of the FTS table associated with this table, if one exists. \n                         \n                     \n                     \n                         await db.label_column_for_table(table)  - string or None \n                         \n                             The label column that is associated with this table - either automatically detected or using the  \"label_column\"  key from  Metadata , see  Specifying the label column for a table . \n                         \n                     \n                     \n                         await db.foreign_keys_for_table(table)  - list of dictionaries \n                         \n                             Details of columns in this table which are foreign keys to other tables. A list of dictionaries where each dictionary is shaped like this:  {\"column\": string, \"other_table\": string, \"other_column\": string} . \n                         \n                     \n                     \n                         await db.hidden_table_names()  - list of strings \n                         \n                             List of tables which Datasette \"hides\" by default - usually these are tables associated with SQLite's full-text search feature, the SpatiaLite extension or tables hidden using the  Hiding tables  feature. \n                         \n                     \n                     \n                         await db.get_table_definition(table)  - string \n                         \n                             Returns the SQL definition for the table - the  CREATE TABLE  statement and any associated  CREATE INDEX  statements. \n                         \n                     \n                     \n                         await db.get_view_definition(view)  - string \n                         \n                             Returns the SQL definition of the named view. \n                         \n                     \n                     \n                         await db.get_all_foreign_keys()  - dictionary \n                         \n                             Dictionary representing both incoming and outgoing foreign keys for this table. It has two keys,  \"incoming\"  and  \"outgoing\" , each of which is a list of dictionaries with keys  \"column\" ,  \"other_table\"  and  \"other_column\" . For example: \n                             {\n    \"incoming\": [],\n    \"outgoing\": [\n        {\n            \"other_table\": \"attraction_characteristic\",\n            \"column\": \"characteristic_id\",\n            \"other_column\": \"pk\",\n        },\n        {\n            \"other_table\": \"roadside_attractions\",\n            \"column\": \"attraction_id\",\n            \"other_column\": \"pk\",\n        }\n    ]\n}", "breadcrumbs": "[\"Internals for plugins\", \"Database class\"]", "references": "[]"}