gethue/parse/parserTypeDefs.js

Hue is an Open source SQL Query Editor for Databases/Warehouses

// Licensed to Cloudera, Inc. under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  Cloudera, Inc. licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @typedef {Object} ParsedLocation
 * @property {number} first_line
 * @property {number} first_column
 * @property {number} last_line
 * @property {number} last_column
 */

/**
 * @typedef {Object} ParsedSqlStatement
 * @property {string} firstToken - The first non comment token of the parsed statement, for instance 'select'
 * @property {string} statement
 * @property {ParsedLocation} location
 * @property {string} type - Always 'statement'
 */

/**
 * @typedef {ParsedSqlStatement[]} SqlStatementsParserResult
 */