api_reference.md

Some Protocols

workspace/executeCommand

bqls.executeQuery

Execute a query and return the virtual text document url.

Request:

{
    "command": "bqls.executeQuery",
    "arguments": ["YOUR_DOCUMENT_URI"]
}

Response:

{
    "textDocument": {
        "uri": "bqls://project/${project}/job/${job}"
    }
}

You can get the result of the query by requesting the bqls/virtualTextDocument.

bqls.listDatasets

list up all datasets in the project.

Request:

{
    "command": "bqls.listDatasets",
    "arguments": ["YOUR_PROJECT_ID"]
}

Response:

{
    "datasets": ["dataset1", "dataset2", "dataset3"]
}

bqls.listTables

list up all tables in the dataset.

Request:

{
    "command": "bqls.listTables",
    "arguments": ["YOUR_PROJECT_ID", "YOUR_DATASET_ID"]
}

Response:

{
    "tables": ["table1", "table2", "table3"]
}

bqls.listJobHistories

list up job histories in the project.

Arguments:

• --all-user: list up all jobs in the project. When this flag is not set, list up only jobs submitted by the user.
• --page-size: job histories size. default is 100.

Request:

{
    "command": "bqls.listJobHistories",
}

Response:

{
    "jobs": [
        {
            "textDocument": { "uri": "bqls://..."},
            "id": "job_id",
            "owner": "user@example.com",
            "summary": "job summary"
        }
    ]
}

bqls.saveResult

save bqls/virtualTextDocument result to file.

arguments:

• 1st: target virtualTextDocument to save from.
• 2nd: target file to save. (currently, only csv file and spreadsheet is supported)
  • csv: file://path/to/target.csv
  • spreadsheet:
    • sheet://new: create new spreadsheet and save result
    • https://docs.google.com/spreadsheets/d/asdf_asdfasdf/edit?gid=123: overwrite result to existing spreadsheet

Request:

{
    "command": "bqls.saveResult",
    "arguments": [
        "bqls://project/${project}/job/${job}",
        "file://path/to/target.csv"
    ]
}

Response:

{
    "url": "https://docs.google.com/spreadsheets/d/1...."
}

Custom API

bqls/virtualTextDocument

Requests a virtual text document from the LSP, which is a read only document that can be displayed in the client. bqls will encode all virtual files under custom schema bqls:, so clients should route all requests for the bqls: schema back to the bqls/virtualTextDocument. I used deno language server protocol below as reference.

For example, bqls can provide a virtual text document for a table information. Currently, bqls:// schema supported the following path:

• table: bqls://project/${project}/dataset/${dataset}/table/${table}
• job: bqls://project/${project}/job/${job}

Requests:

interface VirtualTextDocumentParams {
    textDocument: TextDocumentIdentifier;
}

Response:

interface VirtualTextDocument {
    contents: MarkedString[];
    result: QueryResult;
}

interface QueryResult {
    columns: string[];
    rows: any[][];
}