{ "openapi": "3.0.1", "info": { "title": "Database Schema Explorer", "description": "This Apify Actor connects to various types of databases (SQLite, PostgreSQL, MySQL, Oracle, Microsoft SQL Server), explores their schemas, provides detailed information about tables and columns, shows row counts, and optionally reads sample data.", "version": "0.0", "x-build-id": "5yg3gCJmivTSTw14H" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/balathon~database-schema-explorer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-balathon-database-schema-explorer", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/balathon~database-schema-explorer/runs": { "post": { "operationId": "runs-sync-balathon-database-schema-explorer", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/balathon~database-schema-explorer/run-sync": { "post": { "operationId": "run-sync-balathon-database-schema-explorer", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "db_type", "connection_string" ], "properties": { "db_type": { "title": "Database Type", "enum": [ "sqlite", "postgresql", "mysql", "oracle", "mssql" ], "type": "string", "description": "Type of database to connect to", "default": "sqlite" }, "connection_string": { "title": "Connection String", "type": "string", "description": "Database connection string (e.g., 'sqlite:///database.db' or 'postgresql://user:pass@host:port/db'). For SQLite, you can alternatively upload a database file.", "default": "sqlite:///example.db" }, "sqlite_file": { "title": "SQLite Database File", "type": "string", "description": "Upload a SQLite database file (.db) to explore. Only used when db_type is 'sqlite'." }, "tables_to_explore": { "title": "Tables to Explore", "type": "array", "description": "List of table names to explore. If empty, all tables will be explored.", "items": { "type": "string" }, "default": [] }, "include_sample_data": { "title": "Include Sample Data", "type": "boolean", "description": "Whether to include sample rows from each table", "default": true }, "max_sample_rows": { "title": "Max Sample Rows", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of sample rows to read per table", "default": 10 }, "generate_schema_image": { "title": "Generate Schema Image", "type": "boolean", "description": "Whether to generate an image representation of the database schema", "default": false }, "diagram_type": { "title": "Diagram Type", "enum": [ "mermaid", "plantuml", "graphviz" ], "type": "string", "description": "Type of diagram to generate for the schema image", "default": "mermaid" }, "output_format": { "title": "Output Format", "enum": [ "png", "svg", "pdf" ], "type": "string", "description": "Format of the generated schema image", "default": "png" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }