@gingkoo/pandora-metabase 0.0.1-alpha.1 → 0.0.1-alpha.2

package/README.md

@@ -1,93 +1,79 @@
-# pandora-sql
-
-
-
-## Getting started
-
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
-
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
-
-## Add your files
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+# Pandora-SQL 使用指南
+
+## 功能概述
+
+`Pandora-SQL` 是一个用于动态生成 SQL 查询的工具库，支持通过可视化界面配置表结构、字段及查询逻辑。
+
+### 主要功能
+
+- **动态获取表字段**：使用 `getTableColumns` 方法可以动态获取指定表的最新字段信息，并且可以通过设置 `isCacheColumns=true` 来启用缓存机制（默认开启），减少重复请求。
+- **可视化 SQL 构建**：通过 `MetaBase` 组件，用户能够以图形化的方式构建 SQL 查询，支持多种元数据类型，如 `MetaData`, `MetaJoin`, `MetaFilter` 等。
+- **灵活扩展**：提供了丰富的接口和类型定义，便于根据具体需求进行定制和扩展。
+
+### 类型定义
+
+```ts
+export type MetaListType = 
+  | MetaData 
+  | MetaJoin 
+  | MetaCustom 
+  | MetaFilter 
+  | MetaSummarize 
+  | MetaSort 
+  | MetaLimit;
+
+export interface MetaData_TableType {
+  name: string; // 表名
+  alias: string; // 别名
+}
+
+export interface MetaData_ColumnsType {
+  name: string; // 字段名
+  name_zh: string; // 字段中文名称
+  database_type: SQL_COLUMN_TYPE | string; // 数据库中的字段类型
+  special_type: SpecialType | string; // 特殊类型，如主键、外键等
+  select: boolean; // 是否在查询中选中该字段
+}
+
+export type InitColumnsType = Omit<MetaData_ColumnsType, 'select'>;
+
+export interface MetaBaseProps {
+  loading?: boolean; // 加载状态
+  value?: MetaListType[]; // 当前组件的值，用于回显数据
+  tableData?: MetaData_TableType[]; // 包含表别名的数据
+  showExecute?: boolean; // 是否显示执行按钮，默认为true
+  onExecute?: (params: MetaListType[]) => void; // 点击执行按钮时的回调函数
+  isCacheColumns?: boolean; // 是否启用列缓存，默认为true
+  getTableColumns?: (tableName: string) => Promise<InitColumnsType[]>; // 动态获取表列的方法
+  onChange?: (val: MetaListType[]) => void; // 当选择改变时触发的回调函数
+}
 
 ```
-cd existing_repo
-git remote add origin http://git.server.gingkoo/frontend/pandora/pandora-components/pandora-sql.git
-git branch -M main
-git push -uf origin main
-```
-
-## Integrate with your tools
-
-- [ ] [Set up project integrations](http://git.server.gingkoo/frontend/pandora/pandora-components/pandora-sql/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
-
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
-
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
-
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
-
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
-
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
-
-## License
-For open source projects, say how it is licensed.
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+## 代码示例
+
+```tsx
+	const [table, setTable] = useState([]);
+	const [value, setValue] = useState<MetaListType[]>([]);
+
+	<MetaBase
+		value={value}
+		tableData={table}
+		onChange={setValue}
+		getTableColumns={async (name: string) => {
+			let data: MetaData_ColumnsType[] = [
+				{
+					database_type: 'STRING',
+					name: 'C_RSV5',
+					select: true,
+					special_type: '',
+					name_zh: '备用字段（项目组可使用）',
+				},
+			];
+			return data;
+		}}
+		onExecute={(v) => {
+			console.log(v);
+		}}
+	/>
+```

package/lib/es/index.js

@@ -1,12 +1,11 @@
 /**
- * @gingkoo/pandora-metabase v0.0.1-alpha.1
+ * @gingkoo/pandora-metabase v0.0.1-alpha.2
  */
 import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 import * as React from 'react';
 import React__default, { forwardRef, useRef, useImperativeHandle, useEffect, useState, useMemo } from 'react';
 import cx from 'classnames';
-import { DatePicker, Menu, Dropdown, Button, Input, Tooltip, InputNumber } from '@gingkoo/pandora';
-import { DownArrow, Loading } from '@gingkoo/pandora-icons';
+import { DatePicker, Menu, Dropdown, Button, Input, Tooltip, InputNumber, Spinner } from '@gingkoo/pandora';
 import Styled from 'styled-components';
 import _$2 from 'underscore';
 import ReactDOM from 'react-dom';
@@ -14,6 +13,7 @@ import ReactDOMServer from 'react-dom/server';
 import cloneDeep from 'lodash/cloneDeep';
 import { configure, makeAutoObservable } from 'mobx';
 import 'mobx-react';
+import { DownArrow } from '@gingkoo/pandora-icons';
 import moment from 'dayjs';
 
 function styleInject(css, ref) {
@@ -5541,7 +5541,7 @@ const MetaBase = props => {
     loading,
     showExecute = true,
     onExecute,
-    isCacheColumns,
+    isCacheColumns = true,
     value,
     tableData: _tableData,
     getTableColumns,
@@ -5694,10 +5694,13 @@ const MetaBase = props => {
     }
     return false;
   }, [metaList]);
-  if (loading) return null;
-  return (
-    // @ts-ignore
-    jsx(VisualBox, {
+  // if (loading) return null;
+  return jsx(Spinner, {
+    loading: loading,
+    style: {
+      display: 'block'
+    },
+    children: jsx(VisualBox, {
       ref: popupContainer,
       children: jsxs("div", {
         className: 'sqb',
@@ -5726,8 +5729,9 @@ const MetaBase = props => {
           })
         }), showExecute && jsx(Button, {
           type: 'primary',
+          loading: loading,
           className: `sqb-btn`,
-          icon: loading ? jsx(Loading, {}) : null,
+          // icon={loading ? <Spinner /> : null}
           disabled: loading,
           onClick: () => {
             onExecute?.(metaList);
@@ -5749,7 +5753,7 @@ const MetaBase = props => {
         })]
       })
     })
-  );
+  });
 };
 
 export { MetaBase };