# monaco-sql-intellisense

**Repository Path**: rasir/monaco-sql-intellisense

## Basic Information

- **Project Name**: monaco-sql-intellisense
- **Description**: monaco-editor的sql智能提示
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-02-06
- **Last Updated**: 2024-11-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# monaco-sql-intellisense

#### 介绍

monaco-editor 的 sql 智能提示

#### 安装教程

`npm i @rasir/monaco-sql --save`

#### 使用说明

1.  在需要使用智能提示的文件中引入 `import monacoSqlAutocomplete from '@rasir/monaco-sql';`
2.  在 `monaco-editor` 实例化之后调用 `monacoSqlAutocomplete` 函数

```js
import monacoSqlAutocomplete from "@rasir/monaco-sql";
const editor = monaco.editor.create(document.querySelector("#monaco-wrapper"), {
  value: [""].join("\n"),
  language: "sql",
});
monacoSqlAutocomplete(monaco, editor, {
  language: "sql",
  onSuggestCharsets, // 通过接口获取 数据库支持的字符集 默认值：["utf8", "utf8mb4", "latin1", "gb2312", "big5"]
  onSuggestTimeFunction, // 定制的时间函数 输入$时触发 比如 $[monday(yyyyMMdd,+1d)]
  onSuggestTableNames, // 通过接口获取 集群/库/表
  onSuggestTableFields, // 通过接口获取字段
  onSuggestFunctionName, // 通过接口获取函数名称
  onSuggestUdfName, // 自定义的UDF语句
  /* 以下暂时不支持 */
  onHoverTableField, // 鼠标移入显示字段名
  onHoverTableName, // 鼠标移入显示表名
  onHoverFunctionName, // 输入移入显示函数名
});
```

#### 目前支持语句

1.  select 语句
2.  create table/database/index/view/function 语句
3.  insert 语句
4.  set 语句
5.  delete 语句
6.  update 语句
7.  addUdf 语句
8.  drop 语句
9.  alter 语句
10. rename 语句
11. show 语句
12. decribe 语句
13. explain 语句

#### 鸣谢

1.  [`syntax-parser by ascoders(黄子毅)`](https://github.com/ascoders/syntax-parser)