inspector/protocol/Database.json

   1 {
   2     "domain": "Database",
   3     "availability": "web",
   4     "types": [
   5         {
   6             "id": "DatabaseId",
   7             "type": "string",
   8             "description": "Unique identifier of Database object."
   9         },
  10         {
  11             "id": "Database",
  12             "type": "object",
  13             "description": "Database object.",
  14             "properties": [
  15                 { "name": "id", "$ref": "DatabaseId", "description": "Database ID." },
  16                 { "name": "domain", "type": "string", "description": "Database domain." },
  17                 { "name": "name", "type": "string", "description": "Database name." },
  18                 { "name": "version", "type": "string", "description": "Database version." }
  19             ]
  20         },
  21         {
  22             "id": "Error",
  23             "type": "object",
  24             "description": "Database error.",
  25             "properties": [
  26                 { "name": "message", "type": "string", "description": "Error message." },
  27                 { "name": "code", "type": "integer", "description": "Error code." }
  28             ]
  29         }
  30     ],
  31     "commands": [
  32         {
  33             "name": "enable",
  34             "description": "Enables database tracking, database events will now be delivered to the client."
  35         },
  36         {
  37             "name": "disable",
  38             "description": "Disables database tracking, prevents database events from being sent to the client."
  39         },
  40         {
  41             "name": "getDatabaseTableNames",
  42             "parameters": [
  43                 { "name": "databaseId", "$ref": "DatabaseId" }
  44             ],
  45             "returns": [
  46                 { "name": "tableNames", "type": "array", "items": { "type": "string" } }
  47             ]
  48         },
  49         {
  50             "name": "executeSQL",
  51             "async": true,
  52             "parameters": [
  53                 { "name": "databaseId", "$ref": "DatabaseId" },
  54                 { "name": "query", "type": "string" }
  55             ],
  56             "returns": [
  57                 { "name": "columnNames", "type": "array", "optional": true, "items": { "type": "string" } },
  58                 { "name": "values", "type": "array", "optional": true, "items": { "type": "any" }},
  59                 { "name": "sqlError", "$ref": "Error", "optional": true }
  60             ]
  61         }
  62     ],
  63     "events": [
  64         {
  65             "name": "addDatabase",
  66             "parameters": [
  67                 { "name": "database", "$ref": "Database" }
  68             ]
  69         }
  70     ]
  71 }