From 82ddde865e76b34abe4e74e61bafb3385f15987a Mon Sep 17 00:00:00 2001 From: Willam2004 Date: Sun, 14 Jan 2024 23:13:26 +0800 Subject: [PATCH] docs: improve doc --- docs/zh-cn/README.md | 120 ------------------------------------------- 1 file changed, 120 deletions(-) delete mode 100644 docs/zh-cn/README.md diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md deleted file mode 100644 index 9a57bcf..0000000 --- a/docs/zh-cn/README.md +++ /dev/null @@ -1,120 +0,0 @@ -# FastModel Language - -FML(Fast Model Language) 用于维度建模领域快速构建的一门类SQL语言。主要目标是提供一套kimball维度建模理论下，结合大数据开发场景下的一种领域特定语言。 FML采用了类SQL的语言方式， 创建表语法是参考了SQL标准语法，并有自己的扩展。 -FML是一种模型设计语言，期望做到设计与实现解耦，在设计过程中，不用特别考虑各个大数据引擎的实现方式。 建模引擎会根据FML定义的Schema去驱动底层各个数据引擎的执行和操作。 -用户在使用FML时，并不需要特别关注底层数据引擎的细节部分，只有在实际物化（将设计的表转换为底层引擎的物理表时）阶段，建模引擎会根据物化的选择，将FML语言，转换为数据引擎可识别的SQL语法，并提交任务节点执行。具体与各个数据引擎的转换，请参考 FML Transform。 - -阅读更多: [https://fml.alibaba-inc.com/](https://fml.alibaba-inc.com/) - -### Features - -* 一种支持维度建模的领域特定语言，类SQL语法。 - -* 支持数仓规划、数据标准、标准代码、指标等数仓建设中全流程的语法定义。 - -* 使用Java编写，可以方便的构造语法的节点API进行模型构建。 - -* 支持FML语法转换到常见引擎，如MaxCompute，Hive， Hologres，Mysql, PlantUML等Transform API. - -* 提供基于JDBC Driver的方式，来使用FML语言来与模型引擎进行交互处理。 - -### Grammar Manual - -你可以使用FML语法，来定义维度建模模型信息，比如[表的创建](/zh-cn/model/table.md)等，FML提供了丰富的DDL语句，可以让你快速 进行建模的操作。 - -### Parser Example - -```java - -import com.aliyun.fastmodel.core.parser.FastModelParser; -import com.aliyun.fastmodel.core.parser.FastModelParserFactory; - -public class HelloFML { - //单例 - private static final FastModelParser FAST_MODEL_PARSER = FastModelParserFactory.getInstance().get(); - - public static void main(String[] args) { - String fml - = "create dim table t_1 alias 'alias_name' (col bigint alias 'alias_name' comment 'col_comment') comment 'comment';"; - CreateDimTable createDimTable = FAST_MODEL_PARSER.parseStatement(fml); - //do your work - } -} - -``` - -### Transformer Example - -```java -import com.aliyun.fastmodel.core.tree.BaseStatement; -import com.aliyun.fastmodel.transform.api.Transformer; -import com.aliyun.fastmodel.transform.api.TransformerFactory; -import com.aliyun.fastmodel.transform.api.context.TransformContext; -import com.aliyun.fastmodel.transform.api.dialect.DialectMeta; - -public class HelloFMLTransformer { - public static void main(String[] args) { - DialectMeta dialectMeta = - Transformer < BaseStatement > statementTransformer = TransformerFactory.getInstance().get(dialectMeta); - statementTransformer.transform(statement, context).getNode(); - } -} -``` - -## Building FML from Source - -FML构建准备条件： - -* Unix-like environment (we use Linux, Mac OS X, Cygwin, WSL) -* Git -* Maven (we recommend version 3.5.0+) -* Java 8 - -``` -git clone git@gitlab.alibaba-inc.com:base-biz/fastmodel.git -cd fastmodel -mvn clean package -DskipTests # this will take up to 10 minutes -``` - -## Developing FML - -FML提交者使用IntelliJ IDEA来开发FML代码库，我们推荐IntelliJ IDEA开发Java工程 - -IDE的最小支持集包括: - -* 支持Java工程 -* 支持Maven - -### IntelliJ IDEA - -IntelliJ IDE 支持以下插件 - -* IntelliJ 下载地址: [https://www.jetbrains.com/idea/](https://www.jetbrains.com/idea/) -* IntelliJ ANTLR 插件地址: [https://plugins.jetbrains.com/plugin/7358-antlr-v4](https://plugins.jetbrains.com/plugin/7358-antlr-v4) - -## Documentation - -FML文档会部署在 : [https://fml.alibaba-inc.com](https://fml.alibaba-inc.com) -或者可以从 `docs/` 目录查看源文件。 - -## Fork and Contribute - -当前FML处于内部开源项目，欢迎大家使用和参与并贡献它. 你可以联系我们看是否能够提供一些支持，可以从这边文章描述 -[如何贡献代码](https://fml.alibaba-inc.com/#/zh-cn/how-to-contribute). - -## RoadMap - -```plantuml -projectscale quarterly -@startgantt -Project starts 2022-03-01 -[支持hologres的从sql逆向到fml模型处理] lasts 15 days -[支持clickhouse sql的转换和逆向处理] lasts 30 days -[支持FML元数据能力] lasts 60 days -[引擎语法转换可定制] lasts 30 days -[引擎语法转换可定制]->[支持clickhouse sql的转换和逆向处理] -[支持hologres的从sql逆向到fml模型处理] -> [引擎语法转换可定制] -@endgantt - - -```