# IQL

**Repository Path**: DataService/IQL

## Basic Information

- **Project Name**: IQL
- **Description**: An ad hoc query service based on the spark sql engine.(基于spark sql引擎的即席查询服务)
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 2
- **Created**: 2019-12-27
- **Last Updated**: 2020-12-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## IQL
 
![](https://upload-images.jianshu.io/upload_images/3597066-e19cdef507fd77a7.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
 
[English](https://github.com/teeyog/IQL/blob/master/docs/en/README-EN.md) | 简体中文

基于SparkSQL实现了一套即席查询服务，具有如下特性：
- 优雅的交互方式，支持多种datasource/sink，多数据源混算
- spark常驻服务，基于zookeeper的引擎自动发现
- 负载均衡，多个引擎随机执行
- 多session模式实现并行查询
- 采用spark的FAIR调度，避免资源被大任务独占
- 基于spark的动态资源分配，在无任务的情况下不会占用executor资源
- 支持Cluster和Client模式启动
- 基于Structured Streaming实现SQL动态添加流
- 类似SparkShell交互式数据分析功能
- 高效的script管理，配合import/include语法完成各script的关联
- 对数据源操作的权限验证

支持的数据源：hdfs、hive、hbase、kafka、mysql、es、solr、mongo

支持的文件格式：parquet、csv、orc、json、text、xml

在Structured Streaming支持的Sink之外还增加了对Hbase、MySQL、es的支持



## [Quickstart](https://github.com/teeyog/IQL/blob/master/docs/quick-start.md)
 
## 基本语法 
```
load语法和save语法
load和save语法对数据进行加载和保存操作，只需将配置信息写在where条件后，
如加载mysql数据为一个临时表：
load jdbc.'tableName'
where driver="***"
    and url="***"
as tb_mysql;
这里的tb_mysql可以在后续随意使用，如:select * from tb_mysql; save tb_mysql as json.'path'。

如将数据保存到HBase:
save tb_mysql as hbase.'tbname'
where `hbase.zookeeper.quorum`="localhost:2181"

select语法
select语法和正常的sql没有区别，可以直接as 为一个临时表如：select * from tb_mysql limit 10 as tb_temp; 
这里的tb_temp可以在后续随意使用，select最后没有as **的情况下，会把结果直接显示在web端。
    
explain语法
可以直接explain一个select查询，也可以直接explain一个中间临时表如上面的tb_temp;

import语法
可以导入整个sql脚本

register语法
可以注册udf，注册watermark等

其他语法支持：create、drop、insert、refresh、set、show
``` 
 
 
### HBase
 
#### 加载数据

```
load hbase.t_mbl_user_version_info 
where `spark.table.schema`="userid:String,osversion:String,toolversion:String"
	   and `hbase.table.schema`=":rowkey,info:osversion,info:toolversion" 
	   and `hbase.zookeeper.quorum`="localhost:2181"
as tb;
```

| 参数 | 说明 | 默认值 | 
| ------------- |:-------------:|:-------------:|
| hbase.zookeeper.quorum | zookeeper地址| localhost:2181|
| spark.table.schema | Spark临时表对应的schema（eg: "ID:String,appname:String,age:Int"）| 无 |
| hbase.table.schema| HBase表对应schema（eg: ":rowkey,info:appname,info:age"）| 无 |
|spark.rowkey.view.name| rowkey对应的dataframe创建的temp view名 ，设置了该值后只获取rowkey对应的数据  |  无 |

> 可获取指定rowkey集合对应的数据，spark.rowkey.view.name 即是rowkey集合对应的tempview，默认获取第一列为rowkey列

#### 保存数据

```
save tb1 as hbase.tableName 
where `hbase.zookeeper.quorum`="localhost:2181"
      and `hbase.table.rowkey.filed`="name"
```

| 参数 | 说明 | 默认值 | 
| ------------- |:-------------:|:-------------:|
|hbase.zookeeper.quorum | zookeeper地址| localhost:2181|
|hbase.table.rowkey.field | spark临时表中作为hbase的rowkey的字段名| 第一个字段 |
|bulkload.enable| 是否启动bulkload| false|
|hbase.table.name | Hbase表名  |  无 |
|hbase.table.family | 列族名  |  info |
|hbase.table.region.splits | 预分区方式1:直接指定预分区分区段，以数组字符串方式指定，如 ['1','2','3']  |  无 |
|hbase.table.rowkey.prefix | 预分区方式2:当rowkey是数字，预分区只需指定前缀的formate形式，如 00 即可生成00-99等100个分区  |  无 |
|hbase.table.startKey | 预分区开始key |  无 |
|hbase.table.endKey | 预分区结束key  |  无 |
|hbase.table.numReg | 分区个数 |  无 |
|hbase.check_table | 写入hbase表时，是否需要检查表是否存在  |  false |
|hbase.cf.ttl | ttl | 无 |

### MySQL

- 加载数据
```
load jdbc.ai_log_count 
where driver="com.mysql.jdbc.Driver" 
      and url="jdbc:mysql://localhost/db?characterEncoding=utf8" 
      and user="root" 
      and password="***" 
as tb; 
```

- 保存数据

```
save append tb as jdbc.aatest_delete;
```

> 注意：离线和实时任务都是可以用update模式的

### 文件操作 (其中formate可为：json、orc、csv、parquet、text)
- 加载数据
 ```
load format.`path` as tb;
```

- 保存数据
```
save tb as formate.`path` partitionBy uid coalesce 2;
```

### Kafka

- 离线
 ```
load kafka.`topicName`
where maxRatePerPartition="200"
	and `group.id`="consumerGroupId"
as tb;
select * from tb;
```
| 参数 | 说明 | 默认值 | 
| ------------- |:-------------:|:-------------:|
| autoCommitOffset | 是否提交offset | false | 
- 实时
```
load kafka.`mc-monitor` 
where startingoffsets="latest"
	and failOnDataLoss="false"
	and `spark.job.mode`="stream" 
as tb1;

register watermark.tb1
where eventTimeCol="timestamp"
and delayThreshold="10 seconds"

select window.end as time_end,
count(1) as count
from tb1 a  
group by  window(a.timestamp,"10 seconds","10 seconds")
as tb2;

save tb2 as json.`/tmp/abc6` 
where outputMode="Append"
	and streamName="Stream"
	and duration="10"
	and sendDingDingOnTerminated="true"
	and `mail.receiver`="3146635263@qq.com"
	and checkpointLocation="/tmp/cp/cp16";
```

| 参数 | 说明 | 默认值 | 
| ------------- |:-------------:|:-------------:|
| spark.job.mode | 任务模式（batch:离线任务，stream:实时任务）| batch |
| mail.receiver | 任务失败邮件通知（多个邮箱逗号分隔）| 无 |
| sendDingDingOnTerminated | 钉钉Robot通知 | false |

> 实时任务失败会自动重启，可以通过streamJobMaxAttempts配置（默认3次）。

### 动态注册UDF函数
- 方式一

```
register udf.`myupper`
where func="
	def apply(name:String)={
		name.toUpperCase
	}
";

load jsonStr.'
{"name":"ufo"}
{"name":"uu"}
{"name":"HIN"}
' as tb1;

select myupper(name) as newName from tb1;
```
- 方式二

```
create temporary function myupper as 'cn.mc.udf.MyUPpperUDF' using jar 'hdfs://dsj01:8020/tmp/udf-test-1.0-SNAPSHOT.jar';
```

### include(import等效)语法，通过路径引入脚本片段

![import语法](https://upload-images.jianshu.io/upload_images/3597066-cf42197b02fbaa5c.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)



### 参考
[StreamingPro之MLSQL](https://github.com/allwefantasy/streamingpro)

[spark sql在喜马拉雅的使用之xql](https://github.com/cjuexuan/mynote/issues/21)