diff --git a/docs/components_versioned_docs/version-6.1.0/test.mdx b/docs/components_versioned_docs/version-6.1.0/test.mdx index d5f842ad631..915b072b09d 100644 --- a/docs/components_versioned_docs/version-6.1.0/test.mdx +++ b/docs/components_versioned_docs/version-6.1.0/test.mdx @@ -20,7 +20,7 @@ title: Test --- -import { StoryExample } from '../src/components/StorybookWrapper'; +import { StoryExample } from '../../src/components/StorybookWrapper'; # Test diff --git a/docs/components_versioned_docs/version-6.1.0/ui-components/button.mdx b/docs/components_versioned_docs/version-6.1.0/ui-components/button.mdx index d278d93db73..ea3eb374265 100644 --- a/docs/components_versioned_docs/version-6.1.0/ui-components/button.mdx +++ b/docs/components_versioned_docs/version-6.1.0/ui-components/button.mdx @@ -22,7 +22,7 @@ sidebar_position: 1 --- import { StoryExample, StoryWithControls } from '../../../src/components/StorybookWrapper'; -import { Button } from '../../../superset-frontend/packages/superset-ui-core/src/components/Button'; +import { Button } from '../../../../superset-frontend/packages/superset-ui-core/src/components/Button'; # Button Component diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/advanced-data-type.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/advanced-data-type.tag.mdx index 97e39dd3f29..d9d1c2eb179 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/advanced-data-type.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/advanced-data-type.tag.mdx @@ -5,7 +5,7 @@ description: "Advanced Data Type" custom_edit_url: null --- -Endpoints for advanced data type operations and conversions. +Advanced data type operations and conversions. | Method | Endpoint | Path | |--------|----------|------| diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.ParamsDetails.json new file mode 100644 index 00000000000..992981fc7d3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_delete_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.StatusCodes.json new file mode 100644 index 00000000000..1ffc33fea3f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Themes bulk delete"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.api.mdx new file mode 100644 index 00000000000..2fa7692c19f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/bulk-delete-themes.api.mdx @@ -0,0 +1,68 @@ +--- +id: bulk-delete-themes +title: "Bulk delete themes" +description: "Bulk delete themes" +sidebar_label: "Bulk delete themes" +hide_title: true +hide_table_of_contents: true +api: eJzFVttu3DYQ/RVi0IcYlb22kQKGgjw4roMkNRKju24LWMaGK41XsilSIUcbbwX+ezGkVnvxFkj74idJFOfMOXMjO2iklTUSWgfpbQe50YSaIO1ANo2qckmV0aMHZzSvubzEWvJbRVg7fqFlg5BCpQnnaMEnqxVprVxCAlSR4u850rRAhYTTqnDTHsp7n0ClIYVvLVrer2XN27+Bv0vAomuMdhhcnR4f8+OHOTbWNGipitY1OifnuMHZka30HPyas5k9YE4sAp9k3SjcMlwb+AQKdLmtGnYNKUxKrNGJWaseRRTJIK+PT16W8I2WLZXGVn9jkYrzlkrU1PsXFr+1lcVin55Nw6jk9csq+WxI3JtWF6mYlBi4oyMshEVnWpujKAw6oQ0JfKoc7RM1YARFp6cvnZvGmpw/ZwoF54WWqfhDqqqI+UFrjd2n48K0qghSe4Teml398tI98lETWi2VcGgXaKOKVJxr0Wp8ajDnpIVFYfK8tf9SgO8lSTWEIAGHeWtZI0+ph+8E6e0dDwiSc55cfQPCXQJPh7kpcByoxaGmpJ5DCvnN71eQgJIzVOvPWD383VolDv8Sv15eXU4uRQYlUZOORsrkUpXGUXp2fHY2kk01WpyMiP2NMhBZlmkhDj+IDM77lgmxTsU7lBat+On84uJyPJ5Ovvx2+TkD8MnA6HpJpdEbnIaFgVVVN8bSqt5dpjO9moni7bB8FGfOK6YifpR6EneXKAu07m23IyCDVGTQi8hA/CxkzsU2JfOI2mf6INONrTS9WhE6ciSpdVOO/8Gmzk9yIcchuRtatxbXWTDasdxBovwuKxL3SHkZ5P0XcV1UWCOVpmA1Mbe70tPVRrGbRI7B11Ueu6h/EuR/jRaeHxyLN5lm6kbhkTLz3ZAcvAmn2XaJv1sfFoJi+SYQuUIK/SmSQCOphBS2BXLIQn/FCm8tR3RvYGDX7RX/FgUuUJmmRk19p4aERaCusYZMbpRPR6OOoXzacR36Z2gXrSNTryASWEhb8UBz/XAJMPxe4L1sFfU0IQHUbc2d23/yI/TvNv6HyeRaDDg+AWazjTfofUZuHEcQ/+NbhTBWfLxmENayDbI3VL192O09Z3A1hsZ5TFjaD6MOZqFK3htbS8b79OeEcxS2Qdr/hWGIBtE+YeOpxXuLrvy/IOH+dG+inC32bYPWIW3cwTaWuHbivsVJDImjWobTob+B7a3PLRfDKUH4RKNGyUozVCiiri/cW5BNxf5OmEdQkgDnOSbyFrpuJh3eWOU9L8drIBf1jqvhSIN1BLb9PuIyXBy5ClXL/0PXrUoyHBkJxKYPHqLBeZ5jGEIrq2cnJqMMjRlnCCTAN6SNGAzZ6V/YweoqrJcb8F0Xd8RBwi0VeYS5Cv7Oe/8P7HX75w== +sidebar_class_name: "delete api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Bulk delete themes + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/charts.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/charts.tag.mdx index 07b247cf8a1..d5c057f083b 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/charts.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/charts.tag.mdx @@ -13,8 +13,8 @@ Create, read, update, and delete charts (slices). | `GET` | [Get a list of charts](./get-a-list-of-charts) | `/api/v1/chart/` | | `POST` | [Create a new chart](./create-a-new-chart) | `/api/v1/chart/` | | `GET` | [Get metadata information about this API resource (chart--info)](./get-metadata-information-about-this-api-resource-chart-info) | `/api/v1/chart/_info` | +| `GET` | [Get a chart detail information](./get-a-chart-detail-information) | `/api/v1/chart/{id_or_uuid}` | | `DELETE` | [Delete a chart](./delete-a-chart) | `/api/v1/chart/{pk}` | -| `GET` | [Get a chart detail information](./get-a-chart-detail-information) | `/api/v1/chart/{pk}` | | `PUT` | [Update a chart](./update-a-chart) | `/api/v1/chart/{pk}` | | `GET` | [Compute and cache a screenshot (chart-pk-cache-screenshot)](./compute-and-cache-a-screenshot-chart-pk-cache-screenshot) | `/api/v1/chart/{pk}/cache_screenshot/` | | `GET` | [Return payload data response for a chart](./return-payload-data-response-for-a-chart) | `/api/v1/chart/{pk}/data/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.StatusCodes.json new file mode 100644 index 00000000000..d0849a9c672 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"},"example":{"result":"string"}}},"description":"System dark theme cleared"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.api.mdx new file mode 100644 index 00000000000..d85f40a6455 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-dark-theme.api.mdx @@ -0,0 +1,58 @@ +--- +id: clear-the-system-dark-theme +title: "Clear the system dark theme" +description: "Clear the system dark theme" +sidebar_label: "Clear the system dark theme" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYcAaTImTvQABi37wMgdtF2zB7GAbIsOlqUukRCJV8uTGE/TfhyNlxXYyFGsG7JNo8u74PPfy0C049LU1Hj3IFr49PuaPtobQEC9VXZeFVlRYM7rz1vCe1zlWile1szU6KqK3Q9+UwYvWNYIET64wt9B1yWbHLu9QE3QJ4IOq6hK3/R7tuwQy9NoVNV8MEqZrT1iJTLl7QTlWKHSJymHGob4/PnkB6gq9V7f472EPjnBlVEO5dcVfmEkxbihHQ/39wuHHpghIn9LadoxMvvt/mZxbtyyyDI0Uf9pGZNZ8TSJXKxQ1uqrwnhmRFUpr9F5QXnjh0NvGaXyO4BCPb/zhRd31H7B7ZwidUaXw6FboBDpnnRRjIxqDDzVqwixuCqt14/6haueKVBntwuUedeMKWoO8buHuE4G8nnfzBEjdepDXMOOG9TBP4OFQ2wynAZoP5qUytyBBX/12AQmUaonl488+rxJ040px+If4aXIxmU1ECjlRLUej0mpV5taTPD0+PR2puhitTkZhQEaN8UgLHwZnwYOTgkjT1Ahx+FakMO4bLyRfih95mpz4anx2NplOF7Nff578kgJ0yQDxck25NVsgh40BZlHV1lHoePTkU5OajbyIN8P2UYYlEr5iKOKLuSTRPUeVofNv2j1GKUiRQs8qBfFN37ILsvdoutQcpKZ2haFXG4RHnhQ1fsEVOtgm/l6t1DSUf4v8zuZjnazxzH/grD6pgsQNks4D3xexbSPlCim3GdOL7bCfC7kxFPtl5qR82FS6jQmZhXx8iB4dfzg5r1PDXGyJR6W93c/RwWvg/t6dijMWZBZn4ffFGhKIoEFCLD4kUCvKQcJnqHN2w7DGcWkcJ//ZHMI+oAs+FhmusLR1hYb6sQ+1jYHa2lmy2padHI1aDtXJlnu4exLtrPFkq02IBFbKFWpZRm3ahOF1hjcqPmcMExJA01QsA/1P/gQx2I3/dja7FEOcLgFGsxtv4PsE3DTqGZ8ZVaGwTry75CDMZTfIs6nq/YN113FtN5o21VG8ZK9sLSxD/5xbVymO9/73GdcomIHsT2FQ5EC6S9h54fDGoc+/NEiXQGFubKSzg76p0XnktFBBLPrbW9w70W51ElPiqVLhqeFcfbZzd+4a3h7CBxrVpSrCyxa6qe1b+hpUXfDFJwyoj/K0seebEl9D2y6VxytXdh1vf2zQ8WMyf+yy8KQkECc8TMI9rkHCWGsMErRSZcO4nryoXMxh+KJgQAL8t2OLzZDwfsEX9EfKrLfCt220iKrBUxJxBFWFbt513d/O2JHE +sidebar_class_name: "delete api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Clear the system dark theme + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.StatusCodes.json new file mode 100644 index 00000000000..a15e5453cf5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"},"example":{"result":"string"}}},"description":"System default theme cleared"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.api.mdx new file mode 100644 index 00000000000..15c7ec85cde --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/clear-the-system-default-theme.api.mdx @@ -0,0 +1,58 @@ +--- +id: clear-the-system-default-theme +title: "Clear the system default theme" +description: "Clear the system default theme" +sidebar_label: "Clear the system default theme" +hide_title: true +hide_table_of_contents: true +api: eJzFVmtv2zYU/SvExYA1mBInewABi37IsgRtF3TB7GAbIsOlpZtILUWq5JUbT+B/Hy4pK3aSYY8M2CfRfByecx+H7sGhb63x6EH28PXhIX8KawgN8VC1ra4LRbU1kw/eGp7zRYWN4lHrbIuO6nTaoe90PEXrFkGCJ1ebWwgh28zY5QcsCEIGeKeaVuP2ufv9IYMSfeHqli8GCdO1J2xEiTeq0ySowgZFoVE5LBnt28OjZxBv0Ht1i/+c+XgQrozqqLKu/h1LKU46qtDQcL9w+KmrI9PHyrYPJiXf/L9Kzq1b1mWJRorfbCdKa74kUakVihZdU3vPisgKVRTovaCq9sKht50r8CmBIx7f+N2zCuw/UPfGEDqjtPDoVugEOmedFCdGdAbvWiwIyzQpbFF07k+ydq5I6bQvXu6x6FxNa5DXPXz4TCCv52GeAalbD/IaZlywHuYZ3O0XtsRppObjdq3MLUgorn6+gAy0WqK+/znEVULROS32fxU/nF2czc5EDhVRKycTbQulK+tJHh8eH09UW09WR5PYIJPOeKSFj72zGHonB5HnuRFi/7XI4WSovRh/Kb7nhnLii5PT07PpdDH76cezdzlAyEaWl2uqrNniOU6MTOumtY5i0aMnn5vcbExGvBqnD0rUSPiCqYjnyMkSQoWqROdf9Q9E5SBFDoOwHMRXQ+EuyH5EE3Kzl5vW1YZebEgeeFLU+QXnaW9b+1u1UtNYBFv6dybvs2WN5xCMstVnVZO4QSqqKPm5gvukukGqbMkKU108DIfcbBQPk81xeb/Jd59iMosheZ9OBP5wfF7mhuVYjQfa3j4M095L4ELfbY9TdmZ2aeGfMG7IIPEGCakKIINWUQUS/joAHObYu6l7OsdZeDKY8JDWBS+LEleobdugocEFYpITUN86S7awOsjJpGeoIHuu5/AI7bTzZJsNRAYr5Wq11MmqNjA83hBPNCEDNF3DrjD85E/0hl3817PZpRhxQgbMZhdv1PuI3DTZG68Z1aCwTry5ZBDWsgvyZKiG83F3CJzhjcVNi+RlcjC6Hpaxis6taxTjvf1lxjmK20AOqzAadBQdMj68cHjj0Ff/FiRkUJsbm+TssO9adB45LFQTvwHbU1w7ad/qKIXEU6Piy8Ox+jv1u3Pd+BoR3tGk1aqOb10sqH4o7GtQbc13HzGnAeXJ8p5vEn0Nfb9UHq+cDoGnP3Xo+IWZ39dafGcySN0e++EjrkHCSVFgdKSV0h1Te/TMckrHLkzmARnwf5EtQWPYhwFfMCwps96C7/u0IzkI90riEU0WwjyE8AdoS5vc +sidebar_class_name: "delete api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Clear the system default theme + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.RequestSchema.json new file mode 100644 index 00000000000..b237893fd52 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"json_data":{"type":"string"},"theme_name":{"type":"string"}},"required":["json_data","theme_name"],"type":"object","title":"ThemeRestApi.post"},"example":{"json_data":"string","theme_name":"string"}}},"description":"Theme schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.StatusCodes.json new file mode 100644 index 00000000000..22bc1b75fd7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"json_data":{"type":"string"},"theme_name":{"type":"string"}},"required":["json_data","theme_name"],"type":"object","title":"ThemeRestApi.post"}},"type":"object"},"example":{"id":1,"result":{"json_data":"string","theme_name":"string"}}}},"description":"Theme created"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.api.mdx new file mode 100644 index 00000000000..36397c751aa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-a-theme.api.mdx @@ -0,0 +1,66 @@ +--- +id: create-a-theme +title: "Create a theme" +description: "Create a theme" +sidebar_label: "Create a theme" +hide_title: true +hide_table_of_contents: true +api: eJzNV21P5DYQ/ivWqNKBGlhArYR84sOCOB30dCB2aSsRxHmTgQQS22c7C9so/70aO5vNvlD1jkrXT+vYM+N5nnk89tZg8GuF1h2rdAa8hkRJh9LRUGhd5IlwuZKDR6skzdkkw1LQSBul0bgcLX3R+l0qnF9yM43AwTqTywdoInAZlngnRYkblpvI55AbTIHf9CIt+d1Gcz81ecTE0WruCpoYk9UVWjfU+a5W1tGW+CJKXeBKbvNNl1NapNJEkKJNTK4J9Tw2a1H3E3WmQp+51UraQMLB3v4bKMzTHjmyKidoIOxQFe5/z3izar1cAwK33wfzLUV5pSqJQeEwpZ1+2dt7A/MlWiseXmHqn1B1jnAsUtaeJM7O5FQUecq0MKJEh8YybdQ0TynZdTQ934DlLSr6D7BcS1G5TJn8L0w5G1YuQ+na/VknnA1A+o4eycHBj0aijUroc1IgIxRuxtnvVJyABo1RZhOUE1UVKZPKsTZC601b/fqjxXYmHRopCmbRTNEEFJwNJaskvmhMHKZhkqkkqcwr5fognCg6CiKwmFSGMPKbGh6fHfCb24a6gHiw1Cf8qbPUF152EpXiyKdmvXkh5ANwSK6vPkEEhZhgsfi0qjIJJZ5UpmA7f7LLi9GYxZA5p/lgUKhEFJmyjh/uHR4OhM4H0/2B7wWDGFgcx5KxnY8shmErL880Z8coDBr20/Dk5HQ0uhtf/Hb6ednhJNRoZzzTyNlqmRa2KXtXx/CEsxg4i2EqigpjaN5BE3XYLmcuU7KHrpvo8OWlVsbND7ONZSznFwQ76qZ9x9yifdm/JSEK1hmKFI09qleoCFm3dMTAfmYiIdHeOfWEsmm9CfLRJpix3I6lNrl0W/N0d8l4a3u7T8C5mIqR10+PhKXJRaGVtMRDh108i9yxe3RJ5pF/C+46pF+iy1RKeZN8VjnhczO2qhPC+mUulToQM/a8fIkWLn2lBHbW1RKs53ROVDrj7Hx08Xk3nOD8frZVsyec9bhlzTZZE8XvYxlooVuvo2SF8NZIFbhbqIctMt1+D3QKV/qTv/uYYJ4piCCwAxz8dRyBFi4DDsuEUol8ywiHtjJUwY2FgNUNP9EyS3GKhdIlStc2Hy+QEKjWRjmVqKLhg0FNoRpe04Fo1qKdVNapch4igqkwOfVo2/ZLH4bGKd4L/2LwaUIEKKuSmlH7ST++JS3H/zgeX7IuThMBZbMcr8O7ltwodFVao6cIU4adXVIQwrIcZCNVrb+3bhqq3byzjpLQQnnbX2uYeF1+UKYUFO/8jzHVyJsBb1ehuxc86CYi5zuD9wZt9r1BKIpV8mrx+j/9nhdzBLm8V4GUJQ4qjcZi/9HYmyIFBrvpfiDWulL4a7ONv6bvpfDd1enwxQ10IXJJYbwM61b6NyB0Tnvtz3OHCEgpQQo3UNcTYfHaFE1D018rNHT13S7U6C/ACEKH8SfmCWf+cbDoFV68RUXJrL0C6GgEj2GSoO+Qr9ve9s4wNTiIYNL+JytVSj5GPNNfEPEMHCAC5cnwYvJzoU9X4YkQYlKV6UnWY6xTQzsgVO2SkLNehnUdLEKrpCMcoPgrBZrbpmn+Bt1z4xA= +sidebar_class_name: "post api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Create a theme + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.RequestSchema.json new file mode 100644 index 00000000000..db3999ad724 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"description":{"description":"Group description","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"label":{"description":"Group label","maxLength":150,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"Group name","maxLength":100,"minLength":1,"type":"string"},"roles":{"description":"Group roles","items":{"type":"integer"},"type":"array"},"users":{"description":"Group users","items":{"type":"integer"},"type":"array"}},"required":["name"],"type":"object","title":"GroupPostSchema"},"example":{"description":"string","label":"string","name":"string","roles":[1],"users":[1]}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.StatusCodes.json new file mode 100644 index 00000000000..ce598f08d73 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"description":{"description":"Group description","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"label":{"description":"Group label","maxLength":150,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"Group name","maxLength":100,"minLength":1,"type":"string"},"roles":{"description":"Group roles","items":{"type":"integer"},"type":"array"},"users":{"description":"Group users","items":{"type":"integer"},"type":"array"}},"required":["name"],"type":"object","title":"GroupPostSchema"}},"type":"object"},"example":{"result":{"description":"string","label":"string","name":"string","roles":[],"users":[]}}}},"description":"Group created"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.api.mdx new file mode 100644 index 00000000000..3d5152a6bde --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-groups.api.mdx @@ -0,0 +1,66 @@ +--- +id: create-security-groups +title: "Create security groups" +description: "Create security groups" +sidebar_label: "Create security groups" +hide_title: true +hide_table_of_contents: true +api: eJztWFtv2zYU/ivEwYAmmBLbwQIUKvqQBOmarmuC2t0GREFKSye2GopUSMqJJui/D4eUZPmGoU2BvvQpJnku/L5z4VEq0PhQoLGnKikhrCBW0qK09JPnuUhjblMlB1+MkrRn4jlmnH7lWuWobYqGVgmaWKc5yW4s4Xetipz19wLI+NN7lDM7h/B4dBRAlsp2PQxAFkLwqUAIrS4wAFvmCCEYq1M5gzoAwacodnnyhys+RsfDr/YheYa7XLizVQ/DVQ+jLRa1Elvoakz6wwBSi5kTatRTaXGGmvSbHa41L2ldGNQ77fnDr7BHF8SHItWYQHjt4d90Qmr6BWMLAdjUEmney5Uyduxzog4An3iWiy2kNRR0cVtueJKX64ai69FNB+96dFPT5VZN/qkSFKzJx/7NKZoOismVNJ7vo+HoGcmt0RTC/kz6n0m/mfT1uuxqGSxT57kF0asHKoeNevD4Y43cYkK3+G04fEbOZ2gMn2GPwjai/4O4U4RTnrDmdQnZhVxwkSYs55pnaFEblmu1SBO67Caanq7H8pz6/Q5YPkle2LnS6b+YhOyksHOUtvHPugTaAqSv6JAcHf1oJLlWMS2nAhmhsGXI/qLgeDSotdLboJypQiRMKssaC402uTr+0cl2IS1qyQUzqBeoPYqQnUhWSHzKMbaY+E2m4rjQO8L1hlsuOgoCMBgXmjCG1xV8ebSu+qg/8BlVIoybc+bKz1DrIGAO9kUCIfiCvG3t3M68XABPB7FKcOygGGdecDkjjU8f3/caQ7M0qtAxAY0LLdjBP+zqcjxhEcytzcPBQKiYi7kyNnw5fPlywPN0sBgNWq8D73UQAYuiSDJ28JZFcNIkprtsyE6Ra9Tsl5Ozs/Px+HZy+cf5h1WFMx/dg0mZY8jWA7yUTdiLKoJ7LCMIWQQLLgqMoH4BddChvCrt3L2JLc5uo0OaZrnStm0DJpKRbB919rrbPsyVsXvkl309HYHXmyNPUJvX1Rop/v4NMRGwXxmPKfFvrbpHWTfaBP71NsCR3I9krlNp99qLH5Lw3v5+n4p3fMHHLgd7dKxsLoOvpCFGOhb4I08tu0Mbzx0H38ZA5YFkaOcqIQSUXOvshK0YW88dQv25TZ/KUzRxDH0Olir97PE8bWaQl26JnaqkDNm78eWHQ98P0rtyr2L3WPZYZvU+SRPZryLpCUq45R05a9Q3QkrgoVCzPRLdfwVU02vdzhUuaxljXeF6liAESjwIIOc0+cAuiil8riX5Ii80RXdrkGD9Cu/pmCW4QKHyDKVtmptLHm+oyrWyKlaiDgeDikzVYUVlU29YOyuMVVlrIoAF1ym9Aabpx86Mn1TuuBta3DUhAJRFRs2uWdIf1+lW7b+dTK5YZ6cOgG6zaq/Du3G5se/adEYDEFOaXVyREcKyamQrVY2+k65rimYbBzeoeZCuf1cwdZn6RumMk713f08oRk4MwuYUunfHga4DUr7VeKfRzL/VCFkxSn5cfnGff78PpmFvQBze1AGk8k5tGh4XOWqD/Zm2t0Vp6uUWI8++sRl3b3fjd2dZrH0MNcAtPtlBLngq3eiuXYL5irkGnqfkcwS9dzaAziKlmM+ha6iqKTf4SYu6pu2HAnXph+I2jd3LHIBvVq7U7rF0U8uy7bisF4Ub/9fHE6opr3ESx+ja7m7Zm14boF4JAUybf6BkKiEdzR8pOPwRQgAaCkjbf03Snm/+hZ9dvE1KD5oVe+x1adT8IFTt54ssezesKi/huy7Vvofi3imo6YPhP1evJ8Y= +sidebar_class_name: "post api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Create security groups + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.RequestSchema.json new file mode 100644 index 00000000000..493a46f2ae9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.post"},"example":{"id":1}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.StatusCodes.json new file mode 100644 index 00000000000..2c155d2b7c9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.post"}},"type":"object"},"example":{"id":"string","result":{"id":1}}}},"description":"Item inserted"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.api.mdx new file mode 100644 index 00000000000..792e0fe8d18 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/create-security-user-registrations.api.mdx @@ -0,0 +1,66 @@ +--- +id: create-security-user-registrations +title: "Create security user registrations" +description: "Create security user registrations" +sidebar_label: "Create security user registrations" +hide_title: true +hide_table_of_contents: true +api: eJzFV21P4zgQ/ivW6KQFXaCA7iTkFR8KYrXl9hZEy91JpOq6ydAGEjtrO4VelP9+GjtJ0xd0q2NP+wWSycx4nsePZ9wSNH4t0NhzFS+BlxApaVFaehR5niaRsImSvUejJNlMNMdM0FOuVY7aJmjoLYnpr13mCBwSaXGGGqoqaExq+oiRhQBsYlMy3BnUtzhLjNVuBXOLxvZvBoe5MhaqAPBFZDm5+uTHFWWL0UQ6ySkAOPyuYkxZXVLgkCQaY+BWF1iRweRKGl/hydHx98JnrE7kDPwKRWr/fzq2IrcJaqrqFtUQt8XcwGLGEmlQW4wp2S9HR29gJ0NjxAx3UPQvhbeBcC5iVkuRs4FciDSJWS60yNCiNizXapHEVOw2mk6sx/KWnf4OWO6kKOxc6eRvjDnrF3aO0tbrs1alO4B0Ax2Sk5MfjSTXKqLXaYqMUNglZ3/Q5ng0qLXSu6BcqCKNmVSW1RnqaFrq1x8ttoG0qKVImUG9QO1RcNaXrJD4kmNkMfZGpqKo0K9s1wdhRdpSEIDBqNCEkd+X8Phsgd+Pq3EAVswM8PtXDzmMAyCEzjigsxxpFBYnTcJJYVBPdDcUAng5iFSMQ4fPuDVTIWcUfXf7CQJIxRTT1atRhY4IfVTolB38xW6uhyMWwtzanPd6qYpEOlfG8tOj09OeyJPe4rjXVNDbrqAXAgvDUDJ28JGF0K+V6z5ydo5Co2Y/9S8uLofDyej6t8vP6wEXfvsPRsscOdtUwMo3Zu/KEJ5wGQJnISxEWmAI1TuoghbxzdLOlexgbg0t6iTLlbZNnzChDGUzH9hZa3b9do/WZW+jJvA55ihi1Oas3CDIY6lJCoH9zEREp2Ri1RPKqo4mIs52gQ/lfihznUi714A4JOe9/f0uLVdiIYZOsB1q1owrUShpiJ2WEfEsEsse0EZzx8fb2Sg9qAztXMWEhgS4yRRv3NimpoiBL42sSk/XyLH1JViFdFXlOdtWlvduSJ6qeMnZ1fD686FvJMnDcq9kT7jsMM6qffIm4t+H0pMVCytaoja2oXZSKR6marZHrvvvgZrBRpt0B5017DFij20edM8YcHCXgQByYefA4Vuopy12Pc43iEKTAnZuJGyW9ok+sxgXmKo8Q2nrbukE5hOVuVZWRSqteK9XUqqKl3TMqq1sF4WxKmtSBLAQOqGhYuoG79LQc4wPwl1fXJkQAMoio+5Zv9I/A1tEfhyNblibpwqAqlnP1+LdKm7oxwB9kyJDpjQb3FASwrKeZCdVdbzzrira5WZPhjTEPEg3EEqYOgV/UDoTlO/qzxHtkXMDXn+FdpA50FVAwRONDxrN/L8moSxGydvVff9y/QZ5VAWQyAflAa/hK3LUBrsX1o6J1OX9FseeNGMz4WY4sfmtKl9bsp3tFl9sL09FIim1k11ZH4B7EHlC6x9DZ/YGsHNYkmK8JO6hLKfC4J1Oq4rMXwvUNLPHK1W6yR2A70nu5Dzh0t1qVt3FiTgtqMit6wsdER/RjyJ0nfZ133HnhFNLhACm9a+xTMUUo8Uz3evFM3AAuit4VLz0Nt/vC3+38Tlpt+ku2WGyVUX9QKjqT0IuOxWWpffwzZWOsofiRhNU46qq/gF7kO0v +sidebar_class_name: "post api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Create security user registrations + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/current-user.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/current-user.tag.mdx index 242e437ec80..29d55aba159 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/current-user.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/current-user.tag.mdx @@ -5,9 +5,10 @@ description: "Current User" custom_edit_url: null --- -Get information about the currently authenticated user. +Get information about the authenticated user. | Method | Endpoint | Path | |--------|----------|------| | `GET` | [Get the user object](./get-the-user-object) | `/api/v1/me/` | +| `PUT` | [Update the current user](./update-the-current-user) | `/api/v1/me/` | | `GET` | [Get the user roles](./get-the-user-roles) | `/api/v1/me/roles/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboard-permanent-link.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboard-permanent-link.tag.mdx index af2fd306f8a..6b29a581400 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboard-permanent-link.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboard-permanent-link.tag.mdx @@ -5,7 +5,7 @@ description: "Dashboard Permanent Link" custom_edit_url: null --- -Create and retrieve permanent links to dashboard states. +Permanent links to dashboard states. | Method | Endpoint | Path | |--------|----------|------| diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboards.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboards.tag.mdx index 3d168337203..3583da4f0fa 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboards.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/dashboards.tag.mdx @@ -25,7 +25,9 @@ Create, read, update, and delete dashboards. | `DELETE` | [Delete a dashboard](./delete-a-dashboard) | `/api/v1/dashboard/{pk}` | | `PUT` | [Update a dashboard](./update-a-dashboard) | `/api/v1/dashboard/{pk}` | | `POST` | [Compute and cache a screenshot (dashboard-pk-cache-dashboard-screenshot)](./compute-and-cache-a-screenshot-dashboard-pk-cache-dashboard-screenshot) | `/api/v1/dashboard/{pk}/cache_dashboard_screenshot/` | +| `PUT` | [Update chart customizations configuration for a dashboard.](./update-chart-customizations-configuration-for-a-dashboard) | `/api/v1/dashboard/{pk}/chart_customizations` | | `PUT` | [Update colors configuration for a dashboard.](./update-colors-configuration-for-a-dashboard) | `/api/v1/dashboard/{pk}/colors` | +| `GET` | [Export dashboard as example bundle](./export-dashboard-as-example-bundle) | `/api/v1/dashboard/{pk}/export_as_example/` | | `DELETE` | [Remove the dashboard from the user favorite list](./remove-the-dashboard-from-the-user-favorite-list) | `/api/v1/dashboard/{pk}/favorites/` | | `POST` | [Mark the dashboard as favorite for the current user](./mark-the-dashboard-as-favorite-for-the-current-user) | `/api/v1/dashboard/{pk}/favorites/` | | `PUT` | [Update native filters configuration for a dashboard.](./update-native-filters-configuration-for-a-dashboard) | `/api/v1/dashboard/{pk}/filters` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/database.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/database.tag.mdx index ca6ecd024e1..5bcda1717e3 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/database.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/database.tag.mdx @@ -23,7 +23,6 @@ Manage database connections and metadata. | `GET` | [Get all schemas from a database](./get-all-schemas-from-a-database) | `/api/v1/database/{pk}/schemas/` | | `GET` | [Get database select star for table (database-pk-select-star-table-name)](./get-database-select-star-for-table-database-pk-select-star-table-name) | `/api/v1/database/{pk}/select_star/{table_name}/` | | `GET` | [Get database select star for table (database-pk-select-star-table-name-schema-name)](./get-database-select-star-for-table-database-pk-select-star-table-name-schema-name) | `/api/v1/database/{pk}/select_star/{table_name}/{schema_name}/` | -| `DELETE` | [Delete a SSH tunnel](./delete-a-ssh-tunnel) | `/api/v1/database/{pk}/ssh_tunnel/` | | `POST` | [Re-sync all permissions for a database connection](./re-sync-all-permissions-for-a-database-connection) | `/api/v1/database/{pk}/sync_permissions/` | | `GET` | [Get table extra metadata (database-pk-table-extra-table-name-schema-name)](./get-table-extra-metadata-database-pk-table-extra-table-name-schema-name) | `/api/v1/database/{pk}/table_extra/{table_name}/{schema_name}/` | | `GET` | [Get table metadata](./get-table-metadata) | `/api/v1/database/{pk}/table_metadata/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/datasets.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/datasets.tag.mdx index bc3d3e33c2f..7cedc6b3c1a 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/datasets.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/datasets.tag.mdx @@ -13,13 +13,14 @@ Manage datasets (tables) used for building charts. | `GET` | [Get a list of datasets](./get-a-list-of-datasets) | `/api/v1/dataset/` | | `POST` | [Create a new dataset](./create-a-new-dataset) | `/api/v1/dataset/` | | `GET` | [Get metadata information about this API resource (dataset--info)](./get-metadata-information-about-this-api-resource-dataset-info) | `/api/v1/dataset/_info` | +| `GET` | [Get a dataset](./get-a-dataset) | `/api/v1/dataset/{id_or_uuid}` | +| `GET` | [Get charts and dashboards count associated to a dataset](./get-charts-and-dashboards-count-associated-to-a-dataset) | `/api/v1/dataset/{id_or_uuid}/related_objects` | | `DELETE` | [Delete a dataset](./delete-a-dataset) | `/api/v1/dataset/{pk}` | -| `GET` | [Get a dataset](./get-a-dataset) | `/api/v1/dataset/{pk}` | | `PUT` | [Update a dataset](./update-a-dataset) | `/api/v1/dataset/{pk}` | | `DELETE` | [Delete a dataset column](./delete-a-dataset-column) | `/api/v1/dataset/{pk}/column/{column_id}` | +| `GET` | [Get dataset drill info](./get-dataset-drill-info) | `/api/v1/dataset/{pk}/drill_info/` | | `DELETE` | [Delete a dataset metric](./delete-a-dataset-metric) | `/api/v1/dataset/{pk}/metric/{metric_id}` | | `PUT` | [Refresh and update columns of a dataset](./refresh-and-update-columns-of-a-dataset) | `/api/v1/dataset/{pk}/refresh` | -| `GET` | [Get charts and dashboards count associated to a dataset](./get-charts-and-dashboards-count-associated-to-a-dataset) | `/api/v1/dataset/{pk}/related_objects` | | `GET` | [Get distinct values from field data (dataset-distinct-column-name)](./get-distinct-values-from-field-data-dataset-distinct-column-name) | `/api/v1/dataset/distinct/{column_name}` | | `POST` | [Duplicate a dataset](./duplicate-a-dataset) | `/api/v1/dataset/duplicate` | | `GET` | [Download multiple datasets as YAML files](./download-multiple-datasets-as-yaml-files) | `/api/v1/dataset/export/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/datasources.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/datasources.tag.mdx index a50dd0a0b14..e42211cbbc3 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/datasources.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/datasources.tag.mdx @@ -10,3 +10,4 @@ Query datasource metadata and column values. | Method | Endpoint | Path | |--------|----------|------| | `GET` | [Get possible values for a datasource column](./get-possible-values-for-a-datasource-column) | `/api/v1/datasource/{datasource_type}/{datasource_id}/column/{column_name}/values/` | +| `POST` | [Validate a SQL expression against a datasource](./validate-a-sql-expression-against-a-datasource) | `/api/v1/datasource/{datasource_type}/{datasource_id}/validate_expression/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.StatusCodes.json new file mode 100644 index 00000000000..02e9d275535 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Theme deleted"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.api.mdx new file mode 100644 index 00000000000..f5e6eb013ac --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-a-theme.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-a-theme +title: "Delete a theme" +description: "Delete a theme" +sidebar_label: "Delete a theme" +hide_title: true +hide_table_of_contents: true +api: eJzFVu9P5DYQ/VesUaWCGli4XiXk032gHOjuiq7odukPEcSZZCCGxPbZkz1olP+9Gjub3YWt1PYLn5I4nvF7M8/P7sAprxok9AHkRQfagASnqIIMjGqQv+4hA49fW+2xBEm+xQxCUWGjQHZAj45naUN4ix76/pJnB2dNwMATXu3t8aOwhtAQvyrnal0o0tZM7oI1PLZM6Lx16Emn6AZDULe4slIgr80t9H22GLHXd1gQ9Bngg2pcjWuBy4A+gxJD4bXjpUHCrMIGRYk1EpYc/3pv/2WxnhvVUmW9/gtLKQ5bqtDQsL4Ym7CBympgYvLjyzI5sf5alyUaKf60rSit+Z5EpeYoHPpGh8CMyApVFBiCoEoH4THY1he4ieCYL7F7/bLsPlkSN7Y1pRSzCmNnMBCWIwVRWgzCWBL4oANtYjTmiIxevXpp5TlvuRXqukbBqqNHKX5TtS6T+tB76zfxOLJtXUaqQ4Yhmpf66aU3/wdD6I2qRUA/R59YSHFoRGvwwWHBTYuDwhZF6/9he50oUvVYggwCFq1njmyad98I5MUlOx+pWzbS5CwBLjN42ClsidMILXlsrcwtSCjOP59CBrW6xnr5OWwACUXra7Hzh3h3fHo8OxY5VEROTia1LVRd2UDyYO/gYKKcnsz3J8TrTfZzEHmeGyF23oscDgdHiMWW4mdUHr347vDo6Hg6vZr9+svxpxygz0ZIZ49UWbMCahwYYenGWU8LwYfc5Gbh9uLtOLybPHWLoYh/jT1L0ytUJfrwtnvCIAcpchhY5CB+GLzjiuw9mj4327lxXhvaWiDaDaSoDVfcge1Voh/VXE1je1fIrg0u+2BNYL4jR/VNaRI3SEUV+f0ndl2i2CBVtmQ6qb1PucvFRPG0jVyEL4tOdqkAs8j/S4ro+cHFeJMbxm5r3K3t7dOabL8B1uu6yt/FrgklImjIIOEECamfkKW7gYR1dp2777lmcYslkbeeS7qxMvB02VP+LUqcY21dg4aGzRo7lhJ1zluyha17OZl0nKqXHSuxf5btqA1km0WKDObKa/a0MPhLTMPvJd6otqYBJmSApm148w6f/IhbeD3/+9nsTIx5+gwYzXq+ke8zcNPkQvyPr1fCevHhjJMwl/UkG0s1xMfZfbxrLZxoWiTLkYMfdXAdVXJifaM438ffZzBc3FjX6S+MPhpJ9xkHX3m88Riq/5ukz0CbG5vorKFvHfqAXBbSxFa9OsTaSfPm+6kkgRoVD4jhKvpMn2vpx0OC8IEmrlY63hWigLpBuBegnOa19hnDkEW6e25z6uMFdN21Cnju677n4a8tevb5y6WUosJLHY/KEuSNqgM+AzOeebD1ebi4bYtlqdZBDoPKPEbF1i1/QQb3+Jiu4P0lKy26Q1w9/TgsCox2tQh5drqyRMZdnMwGMuC74krBxjYOL7zARkRdl2Ykx+lHgNGBGWPf/w1ytTvf +sidebar_class_name: "delete api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Delete a theme + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.StatusCodes.json new file mode 100644 index 00000000000..bc30330cbaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.api.mdx new file mode 100644 index 00000000000..6a42ff05b48 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-groups-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-security-groups-by-pk +title: "Delete security groups by pk" +description: "Delete security groups by pk" +sidebar_label: "Delete security groups by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFVt9v2zYQ/leIwx4STImToAMCFX3I0nRNF3RB7XQDosClpbOlhCJZknLjCfzfiyMl2U48DMhLniT+uOP33X13ZAuaG16jQ2MhvW2hkpCC5q6EBCSvkUYPkIDB701lsIDUmQYTsHmJNYe0BbfStKuSDhdowPs72m21khYtbTg5OqJPrqRD6eiXay2qnLtKydG9VZLm1g61URqNq6J1jdbyBW6cZJ2p5AK8T/oZNbvH3IFPAB95rQVuGa4NfAIF2txUmo6GFC4d1qxAgQ4LMn9z9OZ1oX5Wjs1VI4uUTUpkFHW0Dgtm0KrG5MgKhZZJ5Rg+VtbtIjX4CIxOTl6X0Y3URuU0nAlkKF3lVin7ykVVBAwMjVFmF49z1YgiUO08dNZ01G+vralL6dBILphFs0QTWaTsTLJG4qPGnJIWJpnK88ZQ6ezg+IE7LoYQJGAxbwxxpFq8/+Egvb2jgnJ8QfUJ426d/WFUoy3cJUDEAu3LAlKIYp72fqaLsG86W01DGT8e5KrAcSAUC15wuYAU8psvV5CA4DMU62HUHI0bI9jBP+z9xdXF5IJlUDqn09FIqJyLUlmXnh6dno64rkbL41F/+iiePjrOgGVZJhk7+MgyOGtcqUz1b0Cdst+RGzTsl7Pz84vxeDr568+LzxmATwZw1ytXKrkBb5gYAFa1Vsb1BWMzmcm+CbF3w/RhDM8eQWEvYJFEwxJ5gca+a59wySBlGXR8MmC/Mp6TcKdOPaD0mdzPpDaVdHs9tkPruGvslLKyv0n5E1/ycRDKBu2tyXVulLTEfGDLf/DKsTm6vAxMX8izjWRrdKUqiFhM/tMopP1G9jS1FI5vfXbbGIpJiMS3aOHpQ2F5m0lioQQeCrV4Gp39t0A1sF0570MmWQ+eRfBstmJB6BH1UBCQxEsthf9i3eoHT1EN5RxLozEU9J2xg6dwrmiZFbhEoXSN0nWNIeQ0Omq1UU7lSvh0NGrJlU9bUq1/5u28sU7VvYsEltxU1D9t18uCG/ovcM4b4TqYkADKpqZG0Q3pE7rEtv+Pk8k1G/z4BAjNtr+B7zNw49jxaI1eCEwZdnlNTojLtpOdoersw24fngt9LsbUryPJ0PtamAX1fFCm5uTv098T6N4epPy4CkPPDqR9QsZTg3ODtnypE59AJecq0tlC32g0FiksrnJ0LWxOkXbivuVxDIl1NQ+XUfea+h/dbh02XE8OH91IC15Jchrk1HaCvgWuKzr5GDaujwSiX0gg1Q8kgJjhW2jbGbd4Y4T3NP29QUO3zd1aZEH7RRUu7ALSORcWnwEbbl7Y+9I9DffZOojbgLtJLldBy6KhESTwgKv4vvR3pMHQT8LpceEszzG0ut7k2R1P4hkqPbYnSIA3rtwI3pDg7ocO2ImobeOO2KP8ADB0b8Lo/U+D4Nne +sidebar_class_name: "delete api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Delete security groups by pk + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.StatusCodes.json new file mode 100644 index 00000000000..bc30330cbaf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Item deleted"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.api.mdx new file mode 100644 index 00000000000..6de8db61888 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/delete-security-user-registrations-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: delete-security-user-registrations-by-pk +title: "Delete security user registrations by pk" +description: "Delete security user registrations by pk" +sidebar_label: "Delete security user registrations by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFVl1v2zYU/SvExR4STImToAMCFX3I0hRNV3RB7GwDosClpWtLiUSq5JUbT+B/Hy4pyXbsh30BeZJ4SV6ec+4H2UItjayQ0FiI71soFMRQS8ohAiUr5NETRGDwW1MYzCAm02AENs2xkhC3QKuaVxWKcIEGnHvg1bbWyqLlBWcnJ/xJtSJUxL+yrssilVRoNXq0WrFt7bA2ukZDRdhdobVygRsnWTKFWoBzUW/Rs0dMCVwE+CyrusStjesNLoIMbWqKmo+GGK4JK5FhiYQZb39z8uZ1oX7RJOa6UVksJjkKVh0tYSYMWt2YFEWm0QqlSeBzYWkfqcGHZ3R29rqM7lRtdMrDWYkCFRW0isVvsiwyj0GgMdrs43GpmzLzVDsP3W4+6qfXzqlrRWiULIVFs0QTWMTiQolG4XONKQfNG4VO08Zw6ezh+EGSLAcJIrCYNoY5ci0+fieI7x+4oEguuD7hzqK5xUVhyXiq9hYtXdxcw0MEzNAbrzOIIWT1tHc4bSyaqdncOp2tpr62n49SneHYswxdoJRqATGkd7efIYJSzrBcD0Mi8rgxpTj6Q7y/+nw1uRIJ5ER1PBqVOpVlri3F5yfn5yNZF6Pl6ahHMtpFMjpNQCRJooQ4+igSuGgo16b408/G4meUBo344eLy8mo8nk5+/eXqSwLgogHozYpyrTagDoYBbFHV2lBfUTZRieq7lHg3mI+DbAcMRfxHRlFwkqPM0Nh37QteCcQigY5bAuJHIVPO8inpJ1QuUYeJqk2h6KDHeWxJUmOnHK3DTfqf5FKOfVZtSLBlXMdMK8sqDMzld1mQmCOluWf9P3BuA/EKKdcZkwwJ8lKRuF8oXoacpfnaR70Nsky8Kl/DDscfluhtopiRLvG41IuXSh2+BS6e7ZJ77yMseiKCiYgtImK2Er4wAoOhmCAKN2MMf0eNtn5yrLzvD6GsGsOB2asvvIT5madFhkssdV2hoq7T+LgHR21tNOlUly4ejVp25eKWs9zteLtsLOmqdxHBUpqCG7LtmqN3w/8ZzmVTUgcTIkDVVNx5uiF/LOyI+nEyuRGDHxcBo9n2N/DdATcOLZTn+MkhtBHXN+yEuWw72StVt9+vdv790cdlzBdAIOmbaQszn1UftKkk+/v0+wS6xwxXR5iF4RLwpF3Em6cG5wZt/m+duAgKNdeBzhb6pkZjkWWhgvie2TRx7oR1y9MgiaVK+tute579g3zeOni4+wifaVSXslB8gE+ttkv0e5B1wShOYeNuimA33SGCuH7ixAiRv4e2nUmLd6Z0js3fGjR8rT2sk8/XRFb4l0EG8VyWFndADlc8HNx2b9BDsRZ3G3xnlGrlc7xseAQRPOEqPGTdA+em7z/+9DBxkabo22S/ZecxwUk1dIPQziAC2VC+IeQQ+O6HD9iLqG3DitDT3ADQd37G6Nxf5DIFXA== +sidebar_class_name: "delete api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Delete security user registrations by pk + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.ParamsDetails.json new file mode 100644 index 00000000000..724c921ddcf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"get_export_ids_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.StatusCodes.json new file mode 100644 index 00000000000..9db01363d19 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"Theme export"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.api.mdx new file mode 100644 index 00000000000..e805b098be8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/download-multiple-themes-as-yaml-files.api.mdx @@ -0,0 +1,68 @@ +--- +id: download-multiple-themes-as-yaml-files +title: "Download multiple themes as YAML files" +description: "Download multiple themes as YAML files" +sidebar_label: "Download multiple themes as YAML files" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1v2zYQ/ivEYR8STImToAMCFf3gZmmbLuuCxdkLoiClpbPFlCIZknLiCvrvw5GSYjvusPVLPkl8ubvnuTdeA4ZbXqFH6yC9biDXyqPykDbAjZEi515oNbpzWtGey0usOP0Jj5WjH780CCkI5XGOFtqk3+HW8iUk4IWXtJ6jv8VHo62/FYW77VS1bZuAUJDCfY2W7ite0fV7aG8SsOiMVg6DqaODA/p8A+NXYdYhzrStuIcUpkLxoLpD5rwVah5NF+hyKwxpgBQmJVbIIkqi8upfLT73irHaoPUi4q3QOT7HFS8NlgcsenqHebCFj7wyEtcE4S0vmMX7Gp1P2ZlacCkK9hQzZqxeiAKLbWRWZCOXw5flcqV47UttxVcsUjaufYnKd/YDUGG3E1kVjExevSyTT9qzma5VkbJJib2TkdztdG1zZIVGx5T2DB8Fuf85qUFHYHR09NKxMVbntJxKZBQXv0zZH5RuMT5orbbbeJzoWhaBaqehkyZTP710+Zwpj1ZxyRzaBdrIImVjxWqFjwZzClrYZDrPa/uNBHzHPZeDCxJwmNeWOFLLvHvwkF7fULfyfE5tNLYRBzcJPO7lusDLAC12WMnVHFLIr34/hwQkn6J8WsbsoXVtJdv7i70/nbAMSu9NOhpJnXNZaufT44Pj4xE3YrQ4HHkyNoo9a5QBy7JMMbb3gWUw7som+Dtlb5FbtOyH8cnJ6eXl7eS3X04/ZQBtMqC6WPpSqxVcw8aATFRkqM95l6lM9U2avRm29+fodwgH+5/wkyhUIi/QujfNBokMUpZBRyQD9iPjOSXdrddfULWZ2s2UsUL5nR7UPqXZzu7uKs2PfMEvQ3xXqK5tPgVCK0dsB4b8gQvPZujzMhD8DnrNGse0X7PNiBHZz33Qmkh0Enh+jhItfYj060xFoAX3fAC54YLukpa4L/V8h67uvg6v7Hq2/6wflNS8YFUtvTASWSDhGHfs7/Gv52wmKJkTqNCXuohPOyRguC8hha3MyaWhBGMR1JY8vtVxsAnnnI5ZgQuU2lSofFfMIaBRUWOs9jrXsk1Ho4ZUtWlDdttn2k5q53XVq0hgwa2gnue6/hPU0H+BM15L38GEBFDVFRV3t6RPKPF1/R8mkws26GkTIDTr+ga+z8Bdxi5FZzQFMW3Z2QUpCfPImpKtrurk4/TSUmT7TnWZx5aUdv2qgWnIq3f9jPTxzwnFKFyjkSmcPo1MgXSbkPCtxZlFV36vkjDvzXSks4a+NmhdSKV+ZlzZotyJ9xaH0SXOVzw8IN3E+J/zds3s8Lh4fPQjI7lQpD4kVtPl9DVwIwjDIWEL7OjBCX5OgJIgRvkammbKHV5Z2ba0HWdayvgNm8OTCE/uWQfwBZdhCqYUlTWdh1Lt8zU8OQnEHhIsRIFxnmPoYL3U5ohMSobCfX9KAaPpasURQ9i6H1Lez/RquaK6aeKN2JOo1iKG0IuhvWnb9h/7akS1 +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Download multiple themes as YAML files + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/explore-permanent-link.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/explore-permanent-link.tag.mdx index 5a06feba933..5f9e6245ac1 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/explore-permanent-link.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/explore-permanent-link.tag.mdx @@ -5,7 +5,7 @@ description: "Explore Permanent Link" custom_edit_url: null --- -Create and retrieve permanent links to chart explore states. +Permanent links to chart explore states. | Method | Endpoint | Path | |--------|----------|------| diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.ParamsDetails.json new file mode 100644 index 00000000000..2bdb6e98289 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The dashboard id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Whether to include Parquet data files","in":"query","name":"export_data","schema":{"default":true,"type":"boolean"}},{"description":"Limit data export to this many rows per dataset","in":"query","name":"sample_rows","schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.StatusCodes.json new file mode 100644 index 00000000000..acd03970118 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"Example bundle ZIP file"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.api.mdx new file mode 100644 index 00000000000..6e99b758d85 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-dashboard-as-example-bundle.api.mdx @@ -0,0 +1,68 @@ +--- +id: export-dashboard-as-example-bundle +title: "Export dashboard as example bundle" +description: "Exports a dashboard with its charts and datasets in the example format used by the Superset example loading system. The export includes Parquet data files and YAML configuration files." +sidebar_label: "Export dashboard as example bundle" +hide_title: true +hide_table_of_contents: true +api: eJzVV21v2zYQ/iuHw4AlmBonWwcUKvoh69LXrAtqF10XBSktnS02EqmSlBNX0H8fjpTkl7hBuw0r9skWX+6e53h3fNhgRjY1snJSK4zx5KbSxlkQkAmbT7UwGVxLl4N0FtJc+DmVQSacsOQsSAUuJ6AbUVYFwUybUjioLWUwXfqpcV2RseSGNYUWmVRzsEvrqDyAid/PfkGqtKgzsnAmzMeanPcDM1lQcPvu+LdTSLWayXltBGMOkwcYYSWMKMmRsRifN1u82MeKkcwwQsnjlXA5RqhESfx1hREa+lhLQxnGztQUoU1zKgXGDbplxaukcjQng20bbbt5m5PLyYDTPZUdTHrfH2syy5XzEIJLXofrXjOaibpwPZwOxFTrgoTaBeJUlrLz14XVaXC5tFAKtQSjry1UZPoz/Awc6w/rklfjnUG44JDZSitLlhf8eHjIP6lWjpTjv6KqCpn64xp9khUPreyFjGFGUgkPoPNgnZFqjm3bRreSNCTStFZZQfDn8zMfWGwjvH94dIfzD5b3r3uvjK7IOBmgl2StmNMazQHEAEtPP1Dq2FeXzxsb8Y0Stcu1kZ8oi+G4djkp1/mHIbV2kFrfGJj89G2ZPNFmKrOMVAzvdA2ZVt87yMWCOHlKaS0zchpEmpK1IcEMWV2blHYRHOwFdve/LbtX2sFM1yqLff/hkyHrKBsoQKbJgtLct6R1uxgNNtjLz3em/X/A6LlyZJQowJJZkAEyRpsYjhXUim4qSpmdHwSdprX5TB4+EU4UYZ13bimtjXRL31Q/XDuMzy+45p2Yc6PFX/uuavEiwpt7qc5o7OGFPlwINccY0zevTzHCQkypWH122RJjWpsC7v0BT08mkGDuXBWPRoVORZFr6+IHhw8ejEQlR4uj0dDGR0ejrmcKe9mFZJQgJEmiAO49gwSPu5LyhxDDLyQMGfju+PHjk/H4cvL7y5NXCSK30A7m2dLlWq0BHQYGqLL0PbXLGJuoRPX9Dx4NwwdzcnuMA/4pnyhYyUlkZOyjZotVgjEk2DFLEH7oCvLS6StSbaL2E1UZqdxej/KAk3Fvf3+d9wuxEGOfBWvcNwZXR6WVZfoDZXEtpIMZuTT3jP8Nvs0G6bj/hu0zZfbv+2NtAvOJJ/4+7Gj5h6PwMFEBub8Ye9RbMekW6YIOCj3f46X7D5HTvSSX6wxjnPsb0+uGGG9zaqqrdgctDqAvy1AUteH47gwTbhfkKU9DRgsqdFWScl2B++MLhprKaKdTXbTxaNSwqTZuGEJ7y9rj2jpd9iYiXAgjxbQIXag3syE7PEyMkFRdcsF3n/zjS37T/rPJ5AwGO22EjGbT3sD3Frhx6Fw8xyoEtIHnZ2yEuWwa2Rmqbr9f3Xpl0nevMffdQNL3sAanPmme9OrjxdtJL3O8vPKzKzHiSbcRb740NDNk879rpGW9NdOBzgb6TijzBum4va8Pce6EdYujEBLrSuEvlU6xBe2+JnOFHTR3kErbAVu7rv7Pyr8Lr6MbN6oKIb3C8JXRdIV6jqKSHMQjDkHPDyOMveS/Va8YIad2yN1zbJqpsPTGFG3Lw0Ep+0eGtFw8GcYzUVi6I7xf+jLYyeWKlrceCAtR1LzSt4Evx/H1j4M7EG2+EVaILlZ95SvDtPe6k8j7sOPJthNKNyjUch1DD7G6wvaC25C/STyaMHGcpuQvtn7L9itlo+s/PeHKZoW+JtGG+u7+sPGdaJomrAg3UzuA81c042vbvwA/ZGS5 +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Exports a dashboard with its charts and datasets in the example format used by the Superset example loading system. The export includes Parquet data files and YAML configuration files. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.RequestSchema.json new file mode 100644 index 00000000000..014028969fb --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"client_id":{"description":"The SQL query result identifier","type":"string"},"expected_rows":{"description":"Optional expected row count for progress tracking","type":"integer"},"filename":{"description":"Optional filename for the export","type":"string"}},"type":"object"}}},"description":"Export parameters","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.StatusCodes.json new file mode 100644 index 00000000000..82d96ec5388 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"text/csv":{"schema":{"type":"string"}}},"description":"Streaming CSV export"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.api.mdx new file mode 100644 index 00000000000..e612531903a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/export-sql-query-results-to-csv-with-streaming.api.mdx @@ -0,0 +1,66 @@ +--- +id: export-sql-query-results-to-csv-with-streaming +title: "Export SQL query results to CSV with streaming" +description: "Export SQL query results to CSV with streaming" +sidebar_label: "Export SQL query results to CSV with streaming" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/iuHw4AmmBw3WwcUKvohDVqsXdBks7sXREFKS2eLjUSqJGXHE/TfhyNlRX7pinUf8skydTze89xzx1ODhj7XZN0rna0xbjDVypFy/CiqqpCpcFKr8f1otVqN5tqUo9oUpFKdUcZGNs2pFPxUGV2RcZKs91NIUu5WeqOMbGpkxZ4wxmlOMPn1Aj7XZNZgyNaFA5mRcnIuyWCEbl0RxmidkWqBbYR0X1HqKLs1emX3PV76B1HAxg6MXkGqa+Vgrg1URi8MWQvOiPSOffZnSOVoQYYPmcuClCjpX/xvTLxXlxMfqI3bD7ntV/TsE6UOW17a9vra74VKGFGSI2Mx8tmQhql1pqaWF2yllQ2k/vD06U6OHN27cWqX26nYDWbv6IkzJEqpFnA++X0Doo3w2d4BQxF8srz5yzkvyVqxoEMR7NHBORVlVdDWRnwlMugUGcNbtRSFzAYMcSaXkqV3ANRgb8By+rhYPihRu1wb+TdlMZzVLmeJh/OhT/QBIMONAcmPj4vkjTYzmWWkYvhL15Bp9cRBLpYEFZlSWsuInAaRpr7Kcmm5rnVtUjoEsPcX0D17XHTvNXeJWmUxcGvqJMRNpIMAmSYLSjuge2kP1nLvg0/56bGr6K1yZLhfWTJLMkDGaBPDmYJa9S3SL4JO09p8QYdvhOOeynb+cEtpbaRbY3zd4KeVw/j6pr2J0ImFxfgaualfiBneRHg/4hti4mOz3r4QaoExph9+u8AICzGj4uFvJ5UY09oUMPoTri4nU0gwd66Kx+NCp6LItXXx86fPn49FJcfL07H9XBRiNg7d69ZuWto4QUiSRAGMfoYEz7pS8uTH8IqEIQPfnZ2fv55MbqeXv7x+v73hPKRtNF1XFMNu5h5sM3jSJHhH6wRjSHApipoSbJ9gG/Vor9Yu12qAt1/oEcvS3wKd6myiErXp+fCyXz6ptHVHfC58Oy1R2J+TyMjYl80OOQFHR1CC8H1Xz7dO35Fqu91MwstDwBN1nKjKSOWONgBO2Pjo+HhIyTuxFBMvsgEtW4sPYtDKMjM9G2IlpIM5uTT3XPw/JpoAqCSX64yRsOh2WYo3ZrCrJUb/cSOnJlA19Ux9jB62DNUU+NpXVLDeEDzT2TqGd5PL9yeh8OV8fdTAHa0HbEN7zNZM+otEBaIy4URP0k4KOiNd0EmhF0dsevwCuXgPziS745nl7s6jwkq6HHomMcLAHsbIAsUIK+FyjPFrKeA0+94UmkNtWAUHk4m7IV7wa8hoSYWuSlKu63JeZMFRUxntdKqLNh6PG3bVxg1H0O55O6+t0+XGRYRLYaSYFaEVb9yEiXAu6sJ1YWKEpOqSu173l38s7hH683R6Bb2fNkKOZttfj3cvuElo3/zOT53awNsrduLntS0nB6nq9ofpruVsb1r4hC+fANI38gZnXslvtCkF+3v3x5Rz5M0w7t4+zLkedBvx5ltDc0M2/1YnbYRSzfX+1D2pKzKW/HQtHd9xwyXWTrBbngZKrCuFv1nDEP/ftbx1fH/7+hG7KoT004oXWNPJ/BpFJTmWU4bppY7+Y2VL7Bgh6yIk/hqbZiYsfTBF2/KyD41v0gft+Xs1wtCBfH3c0Zq1OuglXqpFzQF+/TuNKyO4OEtT8k12s7n/gGB19MXMnRAjnHUfhaXO2HbgMRr+CeHyzDqgrU9298AwuldCrQcRNE2wCL2TKzSE6m8dbG/atv0H1AwSiw== +sidebar_class_name: "post api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Export SQL query results to CSV with streaming + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.ParamsDetails.json new file mode 100644 index 00000000000..5917115e126 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"items":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"}]},"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.StatusCodes.json new file mode 100644 index 00000000000..b1b9da28cce --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ThemeRestApi.get_list.User"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ThemeRestApi.get_list.User1"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"is_system":{"type":"boolean"},"is_system_dark":{"type":"boolean"},"is_system_default":{"type":"boolean"},"json_data":{"nullable":true,"type":"string"},"theme_name":{"maxLength":250,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"type":"object","title":"ThemeRestApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.api.mdx new file mode 100644 index 00000000000..f328f4dbbdc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-list-of-themes.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-list-of-themes +title: "Get a list of themes" +description: "Gets a list of themes, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata." +sidebar_label: "Get a list of themes" +hide_title: true +hide_table_of_contents: true +api: eJzdWG1v2zYQ/isHYsASzImToB0KFf2QFmmaLmuKJlkHxIFLS2ebDUWqJJXEFfTfhyMlWYrlNGkHdNgnW3w53nMvzx1ZsARtbETmhFYsYofoLHCQwjrQU3BzTNEOILcIH4TVCrSBt6cn7+BLjmYBGTc8RYfGwlQbmArp0Ag1G4DVxvk/GZ8JxUk8cJX4ZRYlxjQLNsNYTEUMsZZ5qqxfkqLjCXd8mw3Y8gAWXRQs1sqhciwqGM8yKWIvePjZkvIFs/EcU07/MqMzNE6gpa9KOv0VDlP/xy0yZBGzjvRl5aAe4MbwBX0HMN1NK2J7JenM9I5fc5mj110tTqYeULVG5ekEDSsHq7uakYnWErnyQ41CPybpcgX2ZVkOmMEvuTCYsOjCYwyIav0vmz168hlj12e7K1x0DYcqT0kcBda4dseAaZOgaX1LPkHZ+m4FZ3sVCXHCSWQDprRq67Ten+2z+t3mFyTCUHCGgKrV5jautOk9KuMzbIkUyuHMO8HPjK34umY6ZML4O+KzvOuFAQsWidgM3dibqEqHkhYLym6ftGQzntLCL6y8JG/bTCsbQnpvZydE9nfmWR42dUnlbI7gtOMSDMbaJODXgVbELzDh8RWqhA1WQrjX/WuSexww9R3dGvH0Q4eGTUCbtuGjkBImCM5wZSV3mMBkAROKRTZgeMvTzBt2H96J+D55bCU2VtxErkjsqqL7DedSBIBIAutOcwk3c1Sw0DkkWv3q4ErpmzYGQaZ7OK11U+zx1vT7/xU79kl6mAU7LHKPKZeU8Qj7LMmlR7KfAKfBoErQPBzzMal05LXoIZAuD96DiEupbzBp6qXTvtI+CqFBm8s1aRrmYGp06r0yQxfOrqljXSmcczXDZDxZrM5NhbGuiaiU3x6jmrk5i35/0mMKkfRTpeQPFnKnhLXOb4tZqWNLBj2jtucDWrefie2aTrfPbdBkibXRxyBPTpRcsMiZHFtrtBonKB0fz/OUK/EVk/7lBil0/vfm22UtsKGWTLVJuWMRS7jDLSf8MSqXkk9IGBnoETCFHduFdZi2ppeN03J6nHBz9c01OOVVpqwuo1o4pjaVpr+pr2+k++y/93TnAXDzPABujOUHvrnxniah10cPaDPKFqk1BX93banulJMHFNC6PF7UGC57Klav0N5qslIrOnJbTN/l5zt03N5Uk+dFQb1yt0dhEfMSAn3+qROUpMGTH+qpUrS2217eVxlbvmk2spc8AcpotC6CI3XNpUjaV7fM6GuRYMJ6ALX2Biy7PxfLueK5m2tDVBrBfu7mqFx1PjS01QOkvdEj2dv72Ugyo2P6nEgEQuEWEfxFzglo0Bht+qC80rlMQGkHlYRqNx319GcH25FyaBSXYNFcowkoIthXkCu8zTCmFskPgo7j3Kxx12tO94XaBHRTinNDGOmu+/mGMvCSbi+Oz3yGej6zlKG3W7FO8NSrFl4NJFczFrH4/MNxfcdcflqdm5gUj3MjYetvODw4gxGbO5dFw6HUMZdzbV30bOfZsyHPxPB6d+jZfDhiMBqNFMDWGxix/Sq6vKEjeIncoIFf9l+9Ojg9HZ+d/HHwbsT8LbxS5/3CzbVqKdQMNCqJNNPG1flnR2qk6tsavGiGib43SA94qN6DsHqOPEFjXxR3tB+xCEasQjBi8BvwmMJs7PQVqnKkNkcqM0K5jVqbbQqsjc3NNr63/Jqfeo+2MHYGl6bXyhLMBhq/4cLBFF0898geg6vogIvqb7jrI0L5qXZTERCeeYCfwo6Sfgjt85EKGlK5b7S7g71apCVuSz3boKWbz/0FO0U310m4mPsnLar7rKs7WcPnS4jY3JCxejGzu5lyTNOQ4DVKnaWoXJV53hdBUJEZ7XSsZRkNhwWJKqOCQqtckfYqt06ntQh68zGCCKru+b2YcHeomiOvJt11qreS6pN+fD525b85O3sPjZxywEibrrwG74pyp4FSaI6KPz1GHr33zyx0B+oI6TVVtd+vLkvyTU0rp3Hgj6gil4JNfGS8rhuutx/PyEd+GTWCfnZ5lfOgqSu8cWODU4N2/r1C/GPNVK/ez07zDI3FdhfXGqLYCeuud4NJrEu5Z/uqUTpEt/K0e9dErcrxn3sLrqzk8NYNM8mFb+98gBdVUl0wngmyxS6rWm42YBSDIcguWFFMuMVzI8uShsOllhJurRHWnXuFC/+C1rzqMp/rdbr48jRggYT8CWHDfhyj575610p17jDG4QEFDDUu7UtIHTbVn9brL1eLluyiCCsCq1GuByU8jfu33vIf+YZTpg== +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Gets a list of themes, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.StatusCodes.json new file mode 100644 index 00000000000..bb81105d79f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ThemeRestApi.get.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ThemeRestApi.get.User1"},"id":{"type":"integer"},"is_system":{"type":"boolean"},"is_system_dark":{"type":"boolean"},"is_system_default":{"type":"boolean"},"json_data":{"nullable":true,"type":"string"},"theme_name":{"maxLength":250,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"type":"object","title":"ThemeRestApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"changed_on_delta_humanized":{},"id":1,"is_system":true,"is_system_dark":true,"is_system_default":true,"json_data":"string","theme_name":"string","uuid":"550e8400-e29b-41d4-a716-446655440000"},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.api.mdx new file mode 100644 index 00000000000..dfc6ad6e458 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-a-theme.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-a-theme +title: "Get a theme" +description: "Get an item model" +sidebar_label: "Get a theme" +hide_title: true +hide_table_of_contents: true +api: eJzdWG1v2zYQ/isEsQ8JpsR24GSZin5ws7RN17VF7awD4sClpbOlmiIVknLiCfrvw5GSLdnKS7sBAfbJ5ssd7zk+fHhUTkPQgYpTE0tBffoGDGGCxAYSksgQOPVoyhRLwIDS1L/KaYzzUmYi6lHBEsDWgnpUwU0WKwipb1QGHtVBBAmjfk7NKsVZsTAwB0WLwstpIIUBYXCYpSmPA4YRdL5pDCOvGadKpqBMDBpbgeRZIuxfjFHX3GujYjGnhVd1MKXYCtsLWDUtQGQJ9a+ojuTtpHLp1VNR6+VsCrzWtkYmNhwwAVIAvfYei2HTIaffIDDUo86DT+dgJhjYpIRc4GSb45sM1GqT5BtaXGOWdSqFdtk46nZdUn4ol21w70n4xMWQb7FlFAGp9ZCZVMREQJwRQaND8iXmnEyBGMWE5sxASKYrMsWsUo/CHUtSm4gB+RAHD/mjO2neSSumLmyP01I6DnedbO/w96fA2v8n4Ns8PQ22Ap1x0xJ8xMQcwsl0tTs2i5U2a1wJu3sPYm4i6p/0W7LkErt9ljF7T3ZS1FXiqr5+3c31/YdlFEECn0GbQRofzsEcXmoXRAVTikkI3LBJlCVMxH+DDVoBCz8KvnLShNMV4F78n7PSeyi6WE/0ShtIasNTKTkw0RiehEwtHp0DM1Zyb3caitAkZMbqj8g4Z1OM2V0Ru6qJSNrSdnTc9R43zzIHeCZVwgz1Xcejhg+o83ZqcZXGrbEjCAPCY22InJHNlfH0q6p2ubR4tgPESKJAhKCeLi/DSN6SC1TA38CwmOunicrawb2XRUMbnyDhJSerVVu0t9Vjqy42VO9BAShX7TWI76iwTfWd3orcbqBG5w2GOms3vY6M9Pi4C6f9bvcAjn6dHvR7Yf+A/dI7Oej3T06Oj/v9brfb3WXVVeXnusmJlp20BUOTKXZ8pmRC/rA1XOHR/r8qFRLQms2hhcKP0GZtSF+xkKDMgTY+uRBLxuOQbEpLkiq5jEMI2/DUbB2W3vNiuRQsM5FUSC+fDDITgTDl+mSt5S1A6oYOSf95kXyQhsxkJkKfYCVTJhkw3VpmCg+zBE2ENATuYkz/Lqi1D4vo6Oi59yZVMsDmlAPBfTErn/yJdHP7A0pJ1YbjTGY8tFBLD6U1LnX83MfnQhhQgnGiQS1BORQ+GQiSCbhLIcBNs51EBkGm7iHga2YYX6fAoxqCTCFGfNl9uzXUv7rGZ4Zhc6tC9v7TqEJ3B4EMYWhDcw9BzsSc+jS4/Py+EvJN07EH25ni5OAv8uZ8RMY0Mib1Ox0uA8YjqY1/2j097bA07ix7Haujnd6YkvF4LAg5eEvGdFAeGJtpn7wCpkCRnwZnZ+fD4WT08ffzD2NK8UlZxvNpZSIpahGtO9YxxUkqlanYrsdiLKp3FXm57sb7fg/jIE8O3HPTI2AhKP0y3wp/TH0ypiWEMSU/ExYg0SZGLkAUY7E/FqmKhdmrwjlEau3t79cBvmNLNrR7WgPZ6NwkXwqNONfY2C2LDZmBCSIL7buA5Q10ftUm27uEML9WG5U7iCOL8KuzKPAH4b4YCxciXqnr8LbAl5Mkh0Mu53s4df+FfQwnYCIZuke0/VCBpSJtBp+niwJTYo+NI26mMGOtwOn2gXmPwySEJXCZJiBMeQDthjhHeaqkkYHkhd/p5Oiq8HMkWLHj7SzTRiaVC48umYpRp6pXp3Xjyq2y7LBhYi1XfrIom/hjj2XT/9vR6BNZ+yk8itE0/a3x7gQ3dMqCY1jLEKnIxSd0gliaTlpTVdrb2UWB+1OpyzBwMuKXGpPTqWXH66pOf/dlRMsvRvb9YEc3NaoFjY+JWzNRMFOgox91Yj+uzORudT3MUlAa6sV/rQu54+Ytey4l2iTMin5Z99kvZ8RybjsztXuj9QNbGaCBO9NJOYttaWu5lZecvqIsjTGMXlVuUo/66QIZ4Lb4iub5lGm4VLwosNt9PUK63xvLfUsvYGW/NyE/eYbj9rRVZHVOY3vBhtSfMa7hAcR7n8uCaJ/ct2D1ChKr+ppVIOmCFtfIZas7dnU3MAgCsHpXmezcyQ2ReHOO/MACrP5UrVhS/kHvreHkuZvhhKxYR2elGwMsin8AfSdZMg== +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.ParamsDetails.json new file mode 100644 index 00000000000..2c6ff23b941 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The dataset ID","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.StatusCodes.json new file mode 100644 index 00000000000..d733fd1d8d4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"},"example":{"result":{}}}},"description":"Dataset drill info"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.api.mdx new file mode 100644 index 00000000000..79768351b29 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-dataset-drill-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-dataset-drill-info +title: "Get dataset drill info" +description: "Get dataset drill info" +sidebar_label: "Get dataset drill info" +hide_title: true +hide_table_of_contents: true +api: eJzFVm1P3EYQ/iurUaWCajDQVEKO8oESIKRRinJHX4QR2bPnzgv2rrM7vkAt//dqdn3m7rioUqjEJ9vrndnnmZdnp4VaWlkhoXWQXLWQo8usqkkZDQmMCxS5JOmQxPlbiEDxai2pgAi0rJC/7iACi18aZTGHhGyDEbiswEpC0gI91LxLacIZWui6a97taqMdOt5wsLfHj8xoQk38Kuu6VJlkDPGtYyDtksPamhotqWBt0TUlLR1kJreYEXRdtL4SAd7Lqi5xxa7reOsq7bc95dyqshRKTw1bv9rbfwbQCp2TM1xC6sgqPftPpIMhXGrZUGGs+gfzRBw1VKCm/nwxZGADn2XDwOTnl2VyauxE5TnqRPxtGpEb/SOJQs5R1Ggr5RwzIiNklqFzggrlhEVnGpvhJoKDv8Du1cuy+2hITE2j80RwA3Fm0BHmAwWRG3RCGxJ4rxxtYjT48IwODl668mprOBVyUqLgqqOHRPwhS5WH6kNrjd3E49g0Ze6p9h56az7ql2d1/v9A61wTWi1L4dDO0QYWiTjSotF4X2PGSfOLwmRZY7/RXqeSZDmEIAKHWWOZIwvq7VeC5OqaZY/kjEV2IS8OriO438lMjiMPLihwKfUMEsguP32ACEo5wfLxs2+BBLLGlmLnL3F2MhYpFER1EselyWRZGEfJ4d7hYSxrFc/3417A4/3Y69kN61mcgkjTVAux806kcNTLg498In5FadGKH46Oj09Go5vx77+dfEwBumhAd/FAhdFL+IaFAaGqamNpUf0u1ale6L54MyzvzpC2GIf4ThpRMC5Q5mjdm3aNTAqJSKEnlIL4qdeUGzJ3qLtUb6e6tkrT1gLcLhfe1vb2Mt33ci5HPuNLlFcWHxNjtGPWA1P5VSoSU6Ss8ESfQbNd4ZosvsV6Bpn050US20B47Pl+DhYdP5j861QHwHzsAHYtFP0mU+JuaWZbvHX7NXBFr/bBGdIwLSxdnRFUSIXJIYEZcqz8/JDAOuO2vuuWSXNUfV+GvmgsB31j7GAdyQf+LXKcY2nqCjX1He5zGhy1tTVkMlN2SRy37KpLWq7Y7om348aRqRYuIphLq1gIXS9K3g2/5ziVfqrwMCEC1E3FHd9/8sN3/ar/d+PxhRj8dBEwmlV/A98n4EZBuvgfD2TCWHF+wU6Yy6qTjaHq7f3uzk9nC/kasfAGkl7EWpj4kjo1tpLs7/2fY+hHPa788BcG8fWku4iNbyxOLbrie510PHlOTaCzgr6p0TpfVaSI9X15iWsn7Jvvh5A4qqS/Vfrh9Zslu3LMcMMQ3lNcl1L5QcMXUtuX8xXIWvGZ+2wdXEIEiR+PH6saIuACCBm+gradSIeXtuw6Xv7SoOVr4/qxyMJUrvzNm0MylaXDJ/CGKxS2PvVz4LZ4MrxvJNEvSv3gK7ts+AsiuMOHMNx311yRXnI8lvDjKMvQC9/C5MnVzaU0NP7ZCWeZp9ClaA657l/Y+0Y4bRt2BA3rBnRewxlg1/0LMVlnnA== +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get dataset drill info + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.StatusCodes.json new file mode 100644 index 00000000000..5454dd1d7e7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of distinct values","type":"integer"},"result":{"items":{"properties":{"text":{"description":"The distinct item","type":"string"}},"type":"object","title":"DistinctResultResponse"},"type":"array"}},"type":"object","title":"DistincResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Distinct field data"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.api.mdx new file mode 100644 index 00000000000..a3270a22d3a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-distinct-values-from-field-data-security-user-registrations-distinct-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-distinct-values-from-field-data-security-user-registrations-distinct-column-name +title: "Get distinct values from field data (security-user-registrations-distinct-column-name)" +description: "Get distinct values from field data (security-user-registrations-distinct-column-name)" +sidebar_label: "Get distinct values from field data (security-user-registrations-distinct-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYR8STI6ToQMCFf2QZmmarugC28EGRIHLSGebKUWqJOXGFfTfhyMlWX4JBmQI8snmyx3vee5VFRTc8BwdGgvxbQVCQQwFdwuIQPEcIYZUyzJXU7+KwOD3UhjMIHamxAhsusCcQ1yBWxV03Toj1BzqOqog1cqhcnTKi0KKlDuh1fDBakV7a9nC6AKNE2hpNRPSodmjMwKhUllmOBWZvykc5rZ3USiHczR0s9nhxvAVrQs+x/036WRqxc+9x2tN+v4BUwcROOEkbczRTQ1K7jCbNlDq2tsIMXwv0azWJH6H+o7Is4VWNqD87fiYfp7JUarLIJShTY0oSAhimCyQOe24ZKrM79EwPWOZsE6o1LEllyVaiPZwYNCW0m1Quvmew8cnnuvUk+Ra+ToOniTwj0Zy5B8fNeTsOu+/VbSy48YNEeAjzwuJPapO1ihv77yjNrG01rCZQJmxjDuv6M3/clOO1m4G3pO8bBrdCcJ7njHKOrQuZldqyaXI2DptWWH0UmSYwR5MPdmA5eR1sdwoXrqFNuInZjE7K90ClWveZ11p2QOkLxiQvHldJF+0YzNdqixmlAQNyUh0W12aFFmm0TKlHcNHQfTvgup00Cu/v3acXSmHRnHJLJolGobGaBOzM8VKhY8FpoTObzKdpqV5wlMfOFUff88/bjEtjXAr314efoTsu4vA8Tm1HLixaEY4F9YZD9WO0Lqz6yu4i+BxkOoMx97Y0J8kV3PqSTejzxCB5Pco18tAPK1LI9ngH3Z5MWEJLJwr4uFQ6pTLhbYuPj0+PR3yQgyXJ8PWvGFp0UxN35BhW9mGVa8H1gmwJEkUY4OPLIGzJiy9SMzeIzdo2C9n5+cX4/F08tefF18SAGqGjenXK7fQqmd8t9GZL/JCG9fGlE1UotrOwd5120dzdAdkB3sJjFHQvECeobHvqi2kCcQsgQZtAuxXxtMUrZ06/Q1VnajDRBVGKHfQWn5EIXxweNjn4hNf8rGPnR4fG5trl2pliZKOBv6DC8dm6NKFZ+GlOKg2iIjbNdv2PTHytXV/FdiYeDK+BomafoiZt4kKaKjFdEi2eGouaYlHUs8P6OrhWz9EbKbbJbrtBs9mRue9LsYOWvADAj/YAD9ohQcB+4CwH0IEObqFzsKYA1GYCWN4Pp3kTF9YQiKXhny912WwjfEzHbMMlyh1kaNyTYnyoRQUVYXRTqda1vFwWJGqOq4oi+odbeeldTpvVUSw5Ebwe4nt0OPVhFFnxv244M2ECFCVOZWsZkk/FnY88nEyuWadnjoCsmZTX4d3x7hxqL10RqwxbdjVtR9StdlSspeqRt7frmsKl9ZTfjQKIH0VruDeB+sHbXJO+j79PYFmnqeEC6frec6DriMSnhqcGbSL5yrxM/JM746T47JAY7E/4PW2KHbCveVJoMS6nPu22EzZL5YMG2Z2LZZm4mEhuVBkjg/EqkmUW+CFIJtPoNcCI9hNF9LevAoRxP2vrbs2dm6hqu65xRsj65q2w9cF5dGWZd34AGvSN838hiv/PUKBL0s691WlzYKgVFj6n0E849LiDv71KwejZmg7ZE892M7yatV/szWkj7e+o2zxhdabEW6cpSn6XtDK7sxFZH9Xri4vKAJpWux5qovD5g9p32tXVYUboXLXnZm+rZGBdf0vJMpPZw== +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get distinct values from field data (security-user-registrations-distinct-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.api.mdx new file mode 100644 index 00000000000..86e77e217a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-metadata-information-about-this-api-resource-theme-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-metadata-information-about-this-api-resource-theme-info +title: "Get metadata information about this API resource (theme--info)" +description: "Get metadata information about this API resource" +sidebar_label: "Get metadata information about this API resource (theme--info)" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/isHYh8STImbYgMKFf2QBmmbvQazuw6wApeWzhYbilRJyo0r6L8PR0qKZDsd0g3oPkki747Pc2881SxDmxpROqEVi9lrdFCg4xl3HIRaaVNw2gK+1JUDlwsL59dXYNDqyqTIIlZywwt0aCyL5zVLtXKoHItrxstSitTrTz5Ysl8zm+ZYcHorjS7ROIHWy2bZItWyKlT3KUiPy+uR2Fip5Gukp9uWyGImlMM1GtZEfmdhxeeD203ULenlB0wdO7SAmXD/L0S3uPVnCIeFf0FVFSyej3y3AzxiKyF9bCJWoimEtUL7dVJywknsVLoPpRWym/5864xQ6wEgbgzfHoAcsWAhZmt0C8qdRRvshoQFpdfHCs2WzuAFCX5kzU3EDNpSKxsc+PTJE3r8N1n0j0HdE+i8tWc5KC0C8EEMxlLd9rioZjlCMAwkcArvhJSwRHCGKyu5wwyWW1jyJUp2wPF0AnfafNFyEKJSvcUtOA2VRdAKpLAO7pNgx/gXEu+hODfjTDqIqbJoYCAFK20ONo/ej4/NNgrmHS9Kiftx3w/0OLKjWM7r5maX0rzDceNTd8zvymEBK6ML+FVnKAnJD/8qaQu0dtw2vhSdAetekb3kGRj8WKF1MVypDZcig/vGDKXRG5Fhxg7wGegGLmfflstbxSuXayM+YxbDeeVyVK493wMV5jCRoaJn8vTpt2ZSGp3S51IiEAu3jeFPCk5gg8Zoc4jKha5kBko7aC202nTUj9862a6UQ6O4BItmgyawiOFcQaXwrsSU+plfBJ2mlXkgXK+447J3QcQsppUhjjRFfPjkWDy/oevB8bUvyVmOBVq6me5OUp3h1EMLQ4fkas1ilr794xcWMekbaf/ZNpuYpZWRcPIXvL6cQcJy58p4MpE65TLX1sXPnjx7NuGlmGzOJo4Om/hbLGGQJIkCOHkDCTtvU8x7O4aXyA0a+O784uJyOl3Mfv/58reEsSbqMV1vXa7VAFW/0OMSRamN64rQJipR3Z0IL/rl0zW6I8IBjwIfBZUceYbGvqh3KCQshoS1NBIG3wNPKeEWTt+iahJ1nKjSCOWOOkinlGJHx8dDkj/xDZ/62A6Ijhbvg6CVJa49P/6JCwcrdGnu6T2aXD1iGHffsBstovq+C1gdaM48y/dBo6EHUX6eqADTj8EdxB0HtEJa4qnU6yMSPX7uB5oCXa6zMAj5AdnlLGYHCJBffA2FLK4Mue0ge7ZbPb/QNmS4QanLApVrq9FHJRiqS6OdTrVs4smkJlNNXFOmNXvWLirrdNGZiNiGG0FNqxtxvJlw1a94JV0Lk0bHdgZtP+nha3Rs/81sdg29nSZihGZsr+e7B24a2gzt0ZUN2sDVtR9DtNkxctBVrb6XbhoKUNdqpmnoKXHbcGq29Onxyv/2UAq/m1GMvBiL2937KcqTbiJSXhhcGbT51xrxE/JK749T06pEY3E4Xw+WKHeC3OYsuMS6gqv7WfTRf3Rw5BP05IRkj3edObh3vuZfsaXs8M5NSsmFIsw+W+u2TOaMl4KInZG4d1nEQrHcdGkzZ3W95BbfGtk0tBx+K6iEHgT70OG3uPU/IpTzsqJ9X8JdAfhLKGKht/gTgsJ5mqLva53W3h08agSvLykFaDwZXLx9IrQvZL2betV2YLuug0RoVlS9AYRv0ayhIfVv1D56Ag== +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.api.mdx new file mode 100644 index 00000000000..10c552d0a55 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-security-user-registrations-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-security-user-registrations-related-column-name +title: "Get related fields data (security-user-registrations-related-column-name)" +description: "Get related fields data (security-user-registrations-related-column-name)" +sidebar_label: "Get related fields data (security-user-registrations-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v00gQ/iur0X1odQ6hJ06qjPhQUIFyiKuSVHdSXYWtPUkW7F0zuw4Nlv/7aXZtx3nhhLhDfEr2ZWbneebVNZSSZIEOyUJ8W4PSEEMp3Qoi0LJAiCE1eVXouV9FQPipUoQZxI4qjMCmKywkxDW4TcnXrSOll9A0UQ2p0Q6141NZlrlKpVNGjz9Yo3lvK1uSKZGcQsurhcod0hGdESid5lWGc5X5m8phYQcXlXa4ROKb7Y4kkhtel3KJx2/yydyqL0ePt5rM/QdMHUTglMt5Y4luTphLh9m8hdI03kaI4VOFtNmS+AmaOybPlkbbgPK3x4/55zs5Sk0VhDK0KamShSCG2QqFM07mQlfFPZIwC9HaKNYyr9BCdIQCQlvlbofR3efwwZE8/pw/EgU6mUknxcJQ/yIrg30CmVF8+IrtQ0kR3C4IS0KL2nlmtvq2UeGRfYNClaF2aqGQjrDwL56eBCUTz9KkdeJhkH2TBi87bcMlAnyQRZnjwKVnW3fc3vmA2kXVqhIhLwWTzoqe/KdwKtDa3QTZ5vGh/wZG94LwXGaCqwNaF4srvZa5ysS2vIiSzFplmMERTAPZgOXs52K50bJyK0PqC2axuKjcigMnvC/6EngEyFAwIHnyc5G8M04sTKWzWIR08CQj021NRSmKzKAV2jiBD4rpPwTV6+BXfv/ZcXalHZKWubBIaySBRIZicaFFpfGhxJTR+U1h0rSir3jqpeQq6e/5xy2mFSm38W3ww+eQfXcROLnk1gg3FmmCS2Udeah2gtZdXF/BXQQPo9RkOPXGhj6aS73k3nkzeQsR5PIe8+0yEM/rinIx+lu8upyJBFbOlfF4nJtU5itjXXz++Px8LEs1Xp+NO/PGlUWa09CQcVvjxvWgVTcJiCRJtBCj1yKBizYqvUQsnqMkJPHLxYsXl9PpfPbnH5fvEgDu2a3l1xu38sW2s73f6K1XRWnIdSFlE53orsGJZ/32oyW6E7ZD/ACIUVC8Qpkh2Wf1HtAEYpFACzYB8auQaYrWzp35iLpJ9GmiS1LanXSGP+IAPjk9HVLxRq7l1EfOgI6dza1DjbbMSM+C/CyVEwt06cqT8IMoqHd4iLu12Pc8E/K+c34dyJh5Lt4HiYZ/mJiniQ5gfFPvgOzR1F4yOT7KzfKEr54+9ZPObq69Qtc34oXCPLNB7UmHd8R4Rzt4R63AKMAdMdxTiKBAtzJZGL8gCrNqDN9NIHvP15GQtxWxc4/6CPZRveVjkeEac1MWqF1bkXzsBEV1ScaZ1ORNPB7XrKqJa86a5kDbi8o6U3QqeKYhJe9z7IYxrybMOAvppwNvJkSAuiq4QrVL/rFw4IPXs9m16PU0EbA1u/p6vAfGTUOp5TNmTRgSV9d+dja0p+QoVa28v900HCCdo/wkFED6olvDvQ/Pl4YKyfre/DWD9jODMyycbsc3D7qJWHhOuCC0q+9V4kf3hTmcI6dViWRxOM8Ntjh2wr31WaDEukL6LtgO//9n+O9Y1jdRHqjHZS6VZgt87NVtatyCLBWbeQaDJhfBYYL4rzv/KEQQDz/77rpouYW6vpcWbyhvGt4OnzmcOXuG9fMBbGnetfIjbvyHUT++g68cXdwHpcry/wzihcwtHsDfvnIyaaeyU/G1B7thXW+Gb3aGDPE2d5wfvph6M8KNizRFX+472YPBh+3v69OrS445HgcHjuojr/3D2o/aVdfhRqjOTW+m71xsYNP8AzuVfkY= +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get related fields data (security-user-registrations-related-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.ParamsDetails.json new file mode 100644 index 00000000000..1eb4bf53a1a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object","title":"get_related_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.StatusCodes.json new file mode 100644 index 00000000000..703e57e2ade --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"properties":{"extra":{"description":"The extra metadata for related item","type":"object"},"text":{"description":"The related item string representation","type":"string"},"value":{"description":"The related item identifier","type":"integer"}},"type":"object","title":"RelatedResultResponse"},"type":"array"}},"type":"object","title":"RelatedResponseSchema"},"example":{"count":1,"result":[]}}},"description":"Related column data"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.api.mdx new file mode 100644 index 00000000000..2e2c7c6023b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-related-fields-data-theme-related-column-name.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-related-fields-data-theme-related-column-name +title: "Get related fields data (theme-related-column-name)" +description: "Get related fields data (theme-related-column-name)" +sidebar_label: "Get related fields data (theme-related-column-name)" +hide_title: true +hide_table_of_contents: true +api: eJzFV9tu2zgQ/RVisA8JVqmbRRcIVPQhLdLbFt0idrELRIHLSGObLUWq5MiNK+jfF0NKsnzpomgf+mTzdnjOzHBm1EAlnSyR0HlIbxpQBlKoJK0gASNLhBRyq+vSzMMoAYefa+WwgJRcjQn4fIWlhLQB2lS83ZNTZgltmzSQW0NoiFdlVWmVS1LWTD56a3hue7ZytkJHCj2PFkoTuiOYCSiT67rAuSrCTkVY+tFGZQiX6HhnNyOdkxseV3KJx3fyytyrr0eXt0j27iPmBAmQIs0TS6S5Qy0Ji3knpW0DR0jhc41uszXiZ2hv2Xi+ssZHlX88fMg/P2ij3NbxUIE+d6riQ5DCbIWCLEktTF3eoRN2ITqOYi11jR6SIyZw6GtNOxbdvQ7vycnj14UlUSLJQpIUC+uGGxkM9g3IFsX7b3AfnxTR7cJh5dCjoWCZLd42KoKy7wBUBRpSC4XuiBX+x9PXEeQ6WOm6c+JhkH0XQjg77cIlAbyXZaVx5NLzrTtubkNA7arqoER8l4KNzkCPfiqcSvR+94Fs3/Gh/0akh4PwVBaCswN6SsUrs5ZaFWKbXkTl7FoVWMARTaOzUcv5r9Xy3siaVtapr1ik4rKmFQdOvF8MKfCIkPHBqOTRr1Xy1pJY2NoUqYjPIRgZ2dze1i5HUVj0wlgSeK/Y/IeiBgy+5c9fHWevDKEzUguPbo1OoHPWpeLSiNrgfYU5qwuTwuZ57b7hqeeSs2TYFy73mNdO0SaUwY9f4uu7TYDkkksjJ5MSPdwmcH+W2wKngVqsmlqaJVfK99dvIAEt71Bvh9HMPK6dFmf/ihdXM5HBiqhKJxNtc6lX1lN68fDiYiIrNVmfT4gvm3S5a9KMSnCbgciyzAhx9lJkcNlFW7B+Kp6idOjEb5fPnl1Np/PZ339dvc0AuBZ3HN9taBWSaM9ymBh4qrKyjvpQ8ZnJTF+4xJNh+sES6YR5iJ8Sk0SIFcoCnX/S7EnKIBUZdLIyEL8Lmefo/ZzsJzRtZk4zUzll6KSn+IBD8OT0dCz6tVzLafD9SPjO5NZJ1njWPuiVX6QisUDKV0HuT4ttdhSn/Vjse5Olf+gd2kTZs6D6QzzR8g+b4HFmIu1QgHvKewbpNlmND7RdnvDW08ehK9l9Fy+QhqK5UKgLH2FPgrKzbuksCjtjYaeQQIm0skVsiiCJHWQK32EUtn14x/El1Y5dc9TCsM/0DS+LAteobVWioS4jBM9HoKZylmxudZtOJg1DtWnD0d0eoD2rPdmyh+Cewil5p7FvhgJM7DEWMlTnQBMSQFOXnCG6If+EPLGL/3I2eycGnDYBZrOLN+g9IDeNqY7X2GrCOvHqXehdrdsDOWqq7nzY3bbs9D7dhU4kigxJr4G7EHLPrSsl473+ZwZdm8/vI65u26cguk348NzhwqFf/ShIaJ0X9rCPm9YVOo/jfmo0xbET963Po0k8lTJUoa75/rGQ3uEwlCtuXSeVlsrwXSHKmi7cb0BWigmdM9EglVu5AA4JpOMPqdve/zfQNHfS43un25an44cDv4U9AkPFha3hdtl8wk341BgaYgjvu4/kCKo8/y8gXUjt8UDm9paT667PORXfurBvf81mfGdPZKy3veWIDykv0Ig7LvMcQ/rtzx60Esx/yC0vrjiKuMEaOWSIpe4Pox/l1TRxR8yh7UAzVBIm2Lb/AQHFNo4= +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get related fields data (theme-related-column-name) + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.StatusCodes.json new file mode 100644 index 00000000000..5bb59253c14 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"description":{"maxLength":512,"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":150,"nullable":true,"type":"string"},"name":{"maxLength":100,"type":"string"},"roles":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"GroupApi.get.Role"},"users":{"properties":{"id":{"type":"integer"},"username":{"maxLength":128,"type":"string"}},"required":["username"],"type":"object","title":"GroupApi.get.User"}},"required":["name"],"type":"object","title":"GroupApi.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"description":"string","id":1,"label":"string","name":"string"},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.api.mdx new file mode 100644 index 00000000000..2b8c2865023 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-groups-by-pk +title: "Get security groups by pk" +description: "Get an item model" +sidebar_label: "Get security groups by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isHYh8STI3joB0CFf3gZmmaruuKOlkHxIFLS2dbDUWqJOXEE/TfhyMlWbbl1ssG5JPNlzs+z73xqILFaCKdZDZRkoXsAi1wCYnFFFIVo2ABy7jmKVrUhoU3BUtoX8btnAVM8hRpdMcCpvFbnmiMWWh1jgEz0RxTzsKC2WVGuxJpcYaalWVQsEhJi9LSMs8ykUScEPS+GoJRtIQzrTLUNkFDo0iJPJXuL2E0LfXG6kTOWBnUE1xrvqTxHS7XJVDmKQtvmJmr+3GtMmibojUr+ARFa+yEbGIFkgGURHYb/AjDakJNvmJkWcC8hpDN0I4J2LiiXNJmZ+NvOerlysjfWHlLVjaZksZb4+T42BvlUbbsorvD4GOPodiIlqs5QmsGpkqDnSN4ISChI/icCAETBKu5NIJbjGGyhAlZlQUMH3iaOUMM4EMSfU8f2zLzllnJdHE3ThfSSbytZNPD/94ETv5/Id+laT/aGk0u7HedTMOUP7xHObNzFr7onwRM5kLwCUHwSbtlG2/OzQyubLahsf/ieA+NtR3bgsfHHRu1Etjhjl2IOvT+8rzLdqtCdeOFbndn54VWeTbIkqMZ2qNPSiCdlBtXC/cFRtu7SJ+c/ghdI7kvwmvj6+ujORLetaq4FfADEImxoKawKon7l+JW8ezQ7BbAKtAoY9T7p89wru7hkjL8V7Q8EWa/pGkU7CyGa7m/R4mqMqY+taO2dGrszPu1rF43VaOeDus32biar9SvHLHu1Jt65XbdJR2GdPfR+ulufapVCr+7FqEM2PP/dBOlaAyfYUcE/cBrjSB7zWOgoEdjQ7iUCy6SGFadC2RaLZIY4y4+LVnPpf+0XK4lz+1c6eRvjEMY5HaO0lbnQ5PZHUTagp7J86dl8kFZmKpcxiHQRVkZGcncRuWackmhAaks4ENC5t8m1ehwjE5Onto3mVYRDScCgfxilyH8SeHm/YNaK93F40zlInZUKw2VNB314qnT51JaumoEGNQL1J5FCAMJucSHDCNympsEFUW53hGAb7jlojFBwAxGuSaO9HD4em9ZeHNLXazlM1eFhtU6uDvIUDkiYo72ZVx1x7WS8cxtGk+WY/fgeHgWqRiHjo1/mgguZyxk0fWn92xVFKuhDzga51rAs7/g4vwKRmxubRb2ekJFXMyVseHp8elpj2dJb9Hv1Uf3/NG9/ojBaDSSAM/ewogNqmxzeEN4jVyjhp8GZ2fnw+H46o/fzj+MGKPnToXs49LOlWxhayYadEmaKW3rVDEjOZJ1zw+vmmm6qw8IBzyCQuAF58hj1OZVsUFkxEIYsYrMiMHPwCOK17FVdyjLkTwcyUwn0h7UwI4oQg8OD9tU3/EFH7rQaNFdm1w5RElDjBuW/J4nFqZoo7kj+UiKxRrPsB7DpueI8JfaeYUne+W4fvESJf0Q8Zcj6cHG3PIG6IYZqk1K4JFQswPaevjSPd5StHNVhbV7WFMfyHbRKLK7kszkMtIHeK7Jip3GYJu5+J6WIcYFCpWlKG2V285JXlGRaWVVpEQZ9noFqSrDgsKv3NJ2lhur0lpFwBZcJ1QC6z7YqfGNypS7nsXBpC6temxXQ/pxib6u/+3V1Udo9JQBIzTr+hq+W+CGvmjRGjU+oDRcfiQlxGVdSaepKnm3uyzJU7UvhlRyPUlXvgo2cXHyRumUk753n69Y9a2DQtmvrrpPR7oMSHiscarRzB+rxH0WmKrtZnCYZ6gNtlv61hTFjt+36HuTGJtyd59UTSJ986n5go896rJdjd14PjYXVOeHogquxQfbywRPXAvrIq2oYv2G8SwhUH3WuhwC5k9lAQuzO4oN7/wbVhQTbvBai7Kkaf9FhBJhJ65dMO5w6b6hUOSKnNZdRtZh7JUm7laPWTjlwuB32B98qrqwQ9h1YP3ykcv2mTWQ7I6VtxTlrja50/3CIIrQVcdaZKsRWCskF+cUOdT1tW7/Jn6qP6S9E05R+B2+2JUNOlfoCWBZ/gN3jPOT +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.api.mdx new file mode 100644 index 00000000000..66287ed15c1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-groups-info +title: "Get security groups info" +description: "Get metadata information about this API resource" +sidebar_label: "Get security groups info" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/iuHwz4kmBo3xQYUKvohDdI0ew3mdB0QBy4tnW02FKmSlBtX0H8fjpQcyXYyrB3QfZJE3h2f5954qjEnl1lZemk0pnhOHgryIhdegNRzYwvBWyBmpvLgl9LByeUFWHKmshlhgqWwoiBP1mF6XWNmtCftMa1RlKWSWdAffXBsv0aXLakQ/FZaU5L1klyQzfNpZlRV6O5Tsp5QlwOxoVIpFsRPvy4JU5Ta04IsNknYmTr5ee92k3RLZvaBMo/7FiiX/v+F6JbW4QzpqQgvpKsC0+uB77aAJziXKsQmwZJsIZ2TJqyzkpdeUafSfWijCW825ztvpV70AAlrxXoP5ASjhRQX5KecO9M22A0LS06vjxXZNZ8hChb8iM1NgpZcabSLDnz29Ck//pss+seg7gh03tqxHJWmEXgvBkOpbntYVFdLgmgYWOAI3kmlYEbgrdBOCU85zNYwEzNSuMfxfILwxj5qOQpxqd7SGryByhEYDUo6D/dJsGX8kcR7KM7NMJP2YqocWehJwdzYvc1j48d/m20czDtRlIp2474b6GFkB7G8rpubbUrXHY6bkLpDfheeCphbU8CvJifFSH74qqQtyLlh23gsOj3WG0V8JXKw9LEi51O40CuhZA73jRlKa1Yypxz38OnpRi7H35bLWy0qvzRWfqY8hZPKL0n79vwAVNr9RPqKgcmzZ9+aSWlNxp8zRcAs/DqFPzk4kQ1Za+w+KqemUjlo46G10GrzUT9+62S70J6sFgoc2RXZyCKFEw2VpruSMu5nYRFMllX2gXC9Fl6ojQsSdJRVljnyFPHhk8f0+oavBy8WoSTH7T6cW1OVjq+oTc+7yNtrpzMyXQShabiHMMG7J5nJaRzYxDlFCb3AFLO3f/yCCarQezefbX9KMausgid/wfnZFUxw6X2ZjkbKZEItjfPp86fPn49EKUer41F39CgePQpHTxAmk4kGePIGJnjS5mfAnMIrEpYsfHdyeno2Hk+vfv/57LcJYpNs0F2u/dLoHr7NwgahLEpjfVfBbqInurtQ4eVm+WhB/oBxwBfSSKLykkRO1r2st8hMMIUJtoQmCN+DyDhvp97ckm4m+nCiSyu1P+jAHXGmHhwe9un+JFZiHFKkR3mweB8Yox2z3jAVn4T0MCefLQPRr6BZD7im3TdsR5BJv++CWEfCV4Hv+6jR8IPJv5joCDjM1R3YLVe0QkbRkTKLAxY9fBEmpIL80rQpHiZuv8QUH6XCvgrlGbO9suzKvR7B7cL8hbchpxUpUxakfVvoIVLRUF1a401mVJOORjWbatKa87DZsXZaOW+KzkSCK2El98Nuegpm4hQxF5XyLUyeStvxtv3kR6j6of03V1eXsLHTJMhohvY2fHfAjWMH4z2eBsBYuLgME46xW0b2uqrVD9JNw6HqgjHm/htJhl5W4ywkyuvwR8Vp/e6KYxTEMG137we0QLpJWHlqaW7JLb/USBi+52Z3UhtXJVlH/dG9t8S5E+VWx9ElzhdC34+54Wex4wsx+QDa5Buc1LutvuQPs2Xj6c6PSiWkZjghEeu2Fq5RlJIxH2PvIkkwgsIEY03cdNlxjXU9E47eWtU0vBx/TLhSHgT+EJBbWodfGU5tVfF+qNkuz8M1lmBsJuGEqHCSZRRaWqe1c4sPKv/8jCPNA07v6t7Eu31h693crNc923UdJWJ34iKNIEJ3xobH3L8BX6WVww== +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.ParamsDetails.json new file mode 100644 index 00000000000..5917115e126 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"items":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"}]},"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.StatusCodes.json new file mode 100644 index 00000000000..a0c8cd60714 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"description":{"maxLength":512,"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":150,"nullable":true,"type":"string"},"name":{"maxLength":100,"type":"string"},"roles":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"GroupApi.get_list.Role"},"users":{"properties":{"id":{"type":"integer"},"username":{"maxLength":128,"type":"string"}},"required":["username"],"type":"object","title":"GroupApi.get_list.User"}},"required":["name"],"type":"object","title":"GroupApi.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.api.mdx new file mode 100644 index 00000000000..4f3f765059d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-groups.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-groups +title: "Get security groups" +description: "Get a list of models" +sidebar_label: "Get security groups" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isHYsASTI2TYB0CFf2QBmmaLmuLOlkHxIFLS2dbDUWqJOXEFfTfhyMlWbLlLGkH9JMtkne8514eHlmwGE2kk8wmSrKQnaEFDiIxFtQUUhWjMCxgGdc8RYvasPC6YJGSFqVlYcF4lokk4iQ++GJIR8FMNMeU079Mqwy1TdDQV6REnkr3N7GYuj92mSELmbE6kTNWBvUA15ov6XuaCL9vS2hDba8mlene8QUXOTrb5fL91AGq1sg8naBmZbAp1YxMlBLIpRtqDPoxTTcbsG/KMmAav+aJxpiF1w6jR1Tbf9PIqMkXjGyf725x2XUcyjwldRTgcR2OgCkdo259Cz5B0fpu5Uh7FSmxiRXIAiaVbNu0PZ7tvfrD5hbEicbIJ+XKbG6iyprerTI+w5bKRFqcuSC4mbFJvm2ZNigwWjnkCflZrkchYN4jIZuhHTsXVeVQ0uKEiuxrjnpJPuMpLfzKyhuKtsmUND6lD/f3fWZ/Z53lXqhb25dzBKssF6AxUjoGtw6UBDtHmPDoFmXMgo0U7g3/luIee0x9W7dGYKq029QLAQntwadECJggWM2lEdxiDJMlTCgXWcDwnqeZc+wxvEuih/SxjdzYCBOFIjabhh433EcZAElsAsgNTnMBd3OUsFQ5xEr+auFWqrs2hoRc93ha65bY073p5P8XP/ZpepwHOyzygCtXlPEE/6zIpUezmwCrQKOMUT8e8wWZdO6s6CGQLg8+gIgLoe4wrpGRJUZp+ySEGk0utpSpn4OpVqmLygyt37umji1HYUdTwVJ+f4FyZucsfH5wGDCZC8En5Airc+xxQBL3E6TLkTWNB8/3H6GxzuC24P5+z0KtBPYg2mZRj94/fu/L2vYp6oQ2Ds4VZZ9plWfHWbJXc/feRyWQtstN1YM8zjpa3of88Oi/TGwkn2TmlaF9fxTtI463slVMzUFzsPWI6NDYI4i7puXr2j03PUzZq7SXxTY4qqO3xTBdXlijgbZQXbTXBfVo3bORhcxp8GX7F/XOZMHvP3SWp2hMt615iJFbsWkE2SseA+UFGhvCuVxwkcSw6ugh02qRxBizHkAtWY/l4OdiuZI8t3Olk28Yh3Cc2zlKW+0PTfL3AGkLOiSHhz8bSaZVRJ8TgUAo7DKEvyk4Hg1qrXQflBOVixikslBpqKRpq+c/O9nOpSUCE2BQL1B7FCEcS8gl3mcY0dHsBkFFUa63hOs1pz61dgF16FGuCSPdsb7cUQXeUNds+cxV6LCaB0dqhkqVgDnY53HVjddKxjO/KGD3zyIV49Dh8FdbweWMhSy6+njBmnOv/jQq1xGhjHIt4Nk/cHZ6CSM2tzYLBwOhIi7mytjwaP/oaMCzZLA4GNSbDvymgxGD0WgkAZ69gRE7rpLSGRrCK+QaNfxyfHJyOhyOL9//efpuxNylsTLsw9LOlWyZ1gw0xiVpprSty9aM5EjWlwt42QwT6++QHfB0BIGXmyOPUZuXxRqOEQthxCosIwa/AY8oT8dW3aIsR3J3JDOdSLtT27VHmbmzu9tG+pYv+NClRAttZ3AVDiUNAW5A8jueWJiijeYO4/chLDoww/ob1uNGeD/XoSs81ksH9bOXKOmHcL8YSW9rzC1v7FzzQrVICdwTarZDS3dfuDtiinauqmx2rzLUVLBtKMhDrgh9ZueaHNjrB7Zefhc0DTEuUKgsRWmrcnbx8YqKTCurIiXKcDAoSFUZFpR45Ya2k9xYldYq6AFDJ8R6dUPl1Pj2dcrd8erMpMa9uvhXn/Tjarur/83l5Qdo9JQBI2u6+hq8G8YNPU/RHHUUoDScf3BvBtTQd5T0uqqSd6vLkqJUx2FILOtBOsYq2MTlyGulU0763n66pBi5ZfQe5GZX9xIHugxIeKxxqtHMv1eJe3mYqs3LxjDPUBtst4WtIcodv25x4F1ibMrdEVJ1X/ReWOOFhlbXriHNabTtebGy1eK9HWSCJ65zc2lWVEl+zXiWkEUHrHUYBKzZkrLCh/2aFcWEG7zSoixp2N+ZqAS22rXNhltcugea5tGQuTqsE9idQgHzBOF28ALHUYSOoWqpjUO4U81npxRC6k9aJ28TyOpP63GRy2VLd1H4FZ5xqPq8EY5s3VNi+S/VWJQk +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get a list of models + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..6e30d8d423b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"keys":{"items":{"enum":["show_columns","description_columns","label_columns","show_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_item_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.StatusCodes.json new file mode 100644 index 00000000000..1d6d78009dc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"id":{"description":"The item id","type":"string"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"result":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.get"},"show_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"show_title":{"description":"A title to render. Will be translated by babel","example":"Show Item Details","type":"string"}},"type":"object"},"example":{"description_columns":{"column_name":"A Nice description for the column"},"id":"string","label_columns":{"column_name":"A Nice label for the column"},"result":{"id":1},"show_columns":["string"],"show_title":"Show Item Details"}}},"description":"Item from Model"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.api.mdx new file mode 100644 index 00000000000..9f3d3e3856b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-user-registrations-by-pk +title: "Get security user registrations by pk" +description: "Get an item model" +sidebar_label: "Get security user registrations by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zYQ/isHYh8STI2bogMKFf3gZmmbruuC2FkHRIFLS2dLNUUqJOXEE/TfhyMlW47lNmsL5FPClzve8/C548kVS9DEOitspiQL2Vu0wCVkFnPIVYKCBazgmudoURsWXlUso30FtykLmOQ50mjBAqbxpsw0Jiy0usSAmTjFnLOwYnZV0K5MWpyjZnUdVCxW0qK0tMyLQmQxpwgGXwyFUXWMC60K1DZDQ6NYiTKX7l+K0XTcG6szOWd10E5wrfmKxgtcbVugLHMWXjGTqttJ6zLoUtGZFXyKojN2RjazAokAJZFdB9+KYTOhpl8wtixg3kPI5mgnFNikgVzTZsfxTYl6tSH5htXXxLIplDSejWdPn3pSvovLPrh7CJ/4GKp7ahmnCJ0ZmCkNNkXwRkBGR/ApEwKmCFZzaQS3mMB0BVNilQUM73heOCKG8DGLv+aP7dC8QytRl/TH6SSdJbtO7t/w/6fA2f8U8H2eHgZboymF3Q3e07GbgXv1eGlQX+A8M1Y7GZkLNHZ4fnY0R3fQVs7s0DEEkRkLagabhHl4onZSq8ezWwCrQKNMUD+c3FGqbuGM7v93tDwT5mGUrh3sTZUtZTxAwI0821N7lNfrsVcVW3dOXo93LueqPeh6m9oeQlzV2Sbcrc+0yuFP9xDUAXv+Q/UmR2P4HHuU8A3214bsNU+A3hk0NoQzueQiS2DzPkGh1TJLMOnD07H1WI4fF8ul5KVNlc7+xSSEYWlTlLY5H9aPaQ+QrqFH8vxxkXxUFmaqlEkIVA4bkpHoNqrUlBMKDUhlAe8yon8X1NqHQ/Ts2WPfTaFVTMOpQKB7sasQ/ia5+ftBrZXuw3GiSpE4qI2HxpqO+u2x0+dMWtSSCzCol6g9ihCGEkqJdwXGdGluElQcl3qPAN9wy8WagoAZjEtNGKk9/HJrWXh1Tb2K5XNXhfY9KVSXCKGbPEuaZqj1NikN6onu2k2mq4nrNe+exCrBkYPou1LB5ZyFLL68+NDW1c3Qq5DGpRbw5B94ezqGiKXWFuFgIFTMRaqMDV88ffFiwItssDwetGEMdsMYHEcMoiiSAE/eQcSGTTq61RBeI9eo4ZfhycnpaDQZ//XH6ceIMep6myjPVzZVshPnemIdaZYXSts2l0wkI9m2fvBqPU2P8gHFAT8IJ/BOUuQJavOqugcqYiFErAEWMfgVeEzinli1QFlH8jCShc6kPWiDPCI5HxwedmG/50s+cjrqQN+a3FyUkobQrxHzW55ZmKGNUwf4J8CttjCH7Rju3yiB/9xeauWBjx3uz96ipj9EwstI+sATbvk66HuUNJuUwCOh5ge09fCl6+1ztKlq0sB9d9mUhewhkKpiURN9Lq19QpSa2O0lid1P6A+0DAkuUagiR2mbAuEuzzuqCq2sipWow8GgIld1WJFE6x1vJ6WxKm9dBGzJdUZ1tG2tnRvfVc24a2BcmNSyNd9lzZD+GCoS2/7fjcfnsPZTB4yi2fa3xrsT3MhXPlqjJguUhrNzckJYtp30UtXYu911TbfW3suI6rYH6WpgxaZOM2+Uzjn5e/9pzJrPYpK4X920og50HZDxRONMo0m/14n7gpyp3SZ6VBaoDXb7/c4UacfvWx57SozNuXuUmoaUfh5o8QLpELZ0SO23q89bp3ZevN7fF5rQLd7ZQSF45npbp7qqyYErxouMAjxmndcmYLuZwAIWFgvSjBfFFauqKTd4qUVd07T/qKYE2RvjvpAWuHKf4aRoUdK6y9pW3t5p5lqGhIUzLgx+hYmDi6bFO4R9B7afR3LVPbMNpFiw+prU7+qXO90vDOMYXTVtTXa6jK1i8/aUFEUtZae1WOuq+Ye894ZTVX6HL4j1Ojr3MFCAdf0ffVdlkQ== +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get an item model + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.ParamsDetails.json new file mode 100644 index 00000000000..beb41857879 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"add_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"edit_columns":{"additionalProperties":{"properties":{"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"type":"object"},"keys":{"items":{"enum":["add_columns","edit_columns","filters","permissions","add_title","edit_title","none"],"type":"string"},"type":"array"}},"type":"object","title":"get_info_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.StatusCodes.json new file mode 100644 index 00000000000..da2fced086e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"add_columns":{"type":"object"},"edit_columns":{"type":"object"},"filters":{"properties":{"column_name":{"items":{"properties":{"name":{"description":"The filter name. Will be translated by babel","type":"string"},"operator":{"description":"The filter operation key to use on list filters","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"permissions":{"description":"The user permissions for this API resource","items":{"type":"string"},"type":"array"}},"type":"object"},"example":{"add_columns":{},"edit_columns":{},"filters":{"column_name":[{}]},"permissions":["string"]}}},"description":"Item from Model"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.api.mdx new file mode 100644 index 00000000000..2c36d7818c5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations-info.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-user-registrations-info +title: "Get security user registrations info" +description: "Get metadata information about this API resource" +sidebar_label: "Get security user registrations info" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/isHYh8STI2bYgMKFf3gBmnrvQa1sw6wApeWzjYbilRJyo0r6L8PR0qKZDvd1hXoPkki747Pc288VSxDmxpROKEVi9krdJCj4xl3HIRaaZNz2gK+1KUDtxEWxlcTMGh1aVJkESu44Tk6NJbF84qlWjlUjsUV40UhRer1R+8t2a+YTTeYc3orjC7QOIHWy2bZItWyzFX7KUiPy6uB2FCp4Gukp9sVyGImlMM1GlZHfmdhxaej23XULunle0wdO7aAmXD/L0S3uPNnCIe5f0FV5iyeD3y3BzxiKyF9bCJWoMmFtUL7dVJywklsVdoPpRWym+5864xQ6x4gbgzfHYEcsWAhZmt0C8qdRRPsmoQFpdeHEs2OzuA5CX5g9U3EDNpCKxsc+OTxY3p8nSz626AeCLTeOrAclBYBeC8GQ6l2e1hUsw1CMAwkcAZvhZSwRHCGKyu5wwyWO1jyJUp2xPF0AnfafNZyEKJSvcUdOA2lRdAKpLAO7pNgz/hnEu+hONfDTDqKqbRooCcFK22ONo/Oj/822yiYdzwvJB7G/TDQw8gOYjmv6pt9SvMWx41P3SG/icMcVkbn8KvOUBKSH/5T0uZo7bBtfC46PdadInvBMzD4oUTrYpioLZcig/vGDIXRW5Fhxo7w6ekGLufflsu14qXbaCM+YRbDuHQbVK453wMV5jiRvqJn8uTJt2ZSGJ3S51IiEAu3i+EPCk5gg8Zoc4zKhS5lBko7aCw02nTUj9862SbKoVFcgkWzRRNYxDBWUCq8KzClfuYXQadpaR4I10vuuOxcEDGLaWmII00R7z86Fs9v6HpwfO1L8tqieYNrYV3oc/YNWje+mtBd1TW/SdbcP621BbWihenrLfzlxCJ29yjVGU49xTC8SK7WLGbp9ZtfWMSkb8jdZ9O0YpaWRsKjP+HV5QwStnGuiEcjqVMuN9q6+Onjp09HvBCj7fmohTE6hDHyMBIGSZIogEevIWHjJoG9RAwvkBs08N344uJyOl3Mfv/58reEsTrqkF7t3EarHtZuoUMr8kIb15a4TVSi2hsXnnfLZ2t0J4QDvgKlKBjaIM/Q2OfVHrGExZCwhlzC4HvgKSX5wulbVHWiThNVGKHcSQv0jNL65PS0T/0nvuVTn089+oPF+4BpZckDHWv+kQsHK3TpxpP+SpSrAe+4/Yb9yJID3rXBrQL5mef+LmjU9CBHPEtUAO8H8hb4nlsaIS3xTOr1CYmePvOjVY5uo5uS8KO627CY/WNa5ENf46E6SkMuPuoptl/dv9A2ZLhFqYsclWu6hY9gMFQVRjudalnHo1FFpuq4olytD6xdlNbpvDURsS03gppqO4J5M2EUWfFSugYmjbbNjNx80sNSxxjafz2bXUFnp44YoRna6/gegJuGNkh7NFKANjC58mOSNntGjrqq0ffSdU1hawMzpSYeSPqGWLGlT5qX/reM0v3tjGLkxVjc7N5PeZ50HZHywuDKoN18qRE/wa/04bg3LQs0Fvvzf2+JcifIbc+DS6zLubqflf0fZ8s3zI2DRARoEnFwau/6+5Jf1oaZwzs3KiQXiqD5pKyaGpkzXgjCf856N1PEDiuFRSzUyk2bNXNWVUtu8drIuqbl8NdDFfQgiYdA3eLO/ydRysuS9n1dt/nv78iIhYbjTwgK4zRF3wJbrYMRYdAdXl1SBtD01JsLujxoXsh6O5SrXc92VQWJ0MGoeAMI381ZTTP0X5CzvGU= +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get metadata information about this API resource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.ParamsDetails.json new file mode 100644 index 00000000000..5917115e126 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"content":{"application/json":{"schema":{"properties":{"columns":{"items":{"type":"string"},"type":"array"},"filters":{"items":{"properties":{"col":{"type":"string"},"opr":{"type":"string"},"value":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"},{"items":{"anyOf":[{"type":"number"},{"type":"string"},{"type":"boolean"}]},"type":"array"}]}},"required":["col","opr","value"],"type":"object"},"type":"array"},"keys":{"items":{"enum":["list_columns","order_columns","label_columns","description_columns","list_title","none"],"type":"string"},"type":"array"},"order_column":{"type":"string"},"order_direction":{"enum":["asc","desc"],"type":"string"},"page":{"type":"integer"},"page_size":{"type":"integer"},"select_columns":{"items":{"type":"string"},"type":"array"}},"type":"object","title":"get_list_schema"}}},"in":"query","name":"q"}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.StatusCodes.json new file mode 100644 index 00000000000..989cea1028d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"description_columns":{"properties":{"column_name":{"description":"The description for the column name. Will be translated by babel","example":"A Nice description for the column","type":"string"}},"type":"object"},"ids":{"description":"A list of item ids, useful when you don't know the column id","items":{"type":"string"},"type":"array"},"label_columns":{"properties":{"column_name":{"description":"The label for the column name. Will be translated by babel","example":"A Nice label for the column","type":"string"}},"type":"object"},"list_columns":{"description":"A list of columns","items":{"type":"string"},"type":"array"},"list_title":{"description":"A title to render. Will be translated by babel","example":"List Items","type":"string"},"order_columns":{"description":"A list of allowed columns to sort","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"properties":{"email":{"maxLength":320,"type":"string"},"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"},"registration_date":{"format":"date-time","nullable":true,"type":"string"},"registration_hash":{"maxLength":256,"nullable":true,"type":"string"},"username":{"maxLength":128,"type":"string"}},"required":["email","first_name","last_name","username"],"type":"object","title":"UserRegistrationsRestAPI.get_list"},"type":"array"}},"type":"object"},"example":{"count":1,"description_columns":{"column_name":"A Nice description for the column"},"ids":["string"],"label_columns":{"column_name":"A Nice label for the column"},"list_columns":["string"],"list_title":"List Items","order_columns":["string"],"result":[{}]}}},"description":"Items from Model"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.api.mdx new file mode 100644 index 00000000000..af4fb6aa289 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/get-security-user-registrations.api.mdx @@ -0,0 +1,68 @@ +--- +id: get-security-user-registrations +title: "Get security user registrations" +description: "Get a list of models" +sidebar_label: "Get security user registrations" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1PGzkQ/iuWddKBLhDg2gpt1Q8poi0t16IC15MISp3dSeLitbe2N5Cu9r+fxt7deJMNB+WkfkrWL+N55uWZsQuagIk1zyxXkkb0LVjCiODGEjUhqUpAGNqjGdMsBQva0OiqoLGSFqSlUUFZlgkeM9ze/2ZQRkFNPIOU4b9Mqwy05WDwK1YiT6X7yy2k7o9dZEAjaqzmckrLXj3AtGYL/J5w4c8NNq2J7ZSkMt05PmciB6e7XHyaOEDVGpmnY9C07K3vakbGSglg0g01Cj1N0vUa7Ouy7FEN33OuIaHRlcPoEdX6Xzd71PgbxLbLdjewaBsOZJ6iOHTwqHZHjyqdgA6+BRuDCL6DGAlXoRDLrQDao1LJUKfN/gzP6nabW5BwDbEPyqXazMSVNp1HZWwKgUguLUydE9zMyPAfG6YNCIiXBnlEfJarXuhRb5GITsGOnImqdChxMcck+56DXqDNWIoLv9PyGr1tMiWND+mDvT0f2T+ZZ7nf1M7tixkQqywTREOsdELcOqIksTMgYxbfgExoby2EO92/IblHHlPX0cEImSjtDvWbCG7aJV+4EGQMxGomjWAWEjJekDHGIu1RuGNp5gw7IB95fJ88uhYba25CVyRmXdFBw30YAYQnpkdyA5NckNsZSLJQOUmU/N2SG6luQwwcTfdwWmun2OOt6fb/L3bskvQwC7ZY5B5TLinjEfZZkkuHZDdBrCIaZAL64ZhPUaUTp0UHgbR58B5ETAh1C0mNDDUxSttHIdRgcrEhTf0cmWiVOq9Mwfqza+rYUAohZdwVw5TdnYKc2hmN/jzY64A64drYJr6C5S+edazmSTdxCvYIIRqm3FjtOGyUMOs2TZROmaURxYEdy1NXTHIh2BgdZnUO/yVqxsxs5fyD5y8eICU3oDuU3z847Ar/sBx7O7esGBojEL1WppcF4tKA/hwAMZ/B2MHZyW5dOR5QbsoguBvi399I2S1aeQCR1jR5VRviuoO5OoV2ssoaZ7TkBhnfztOVtAw31Ul0VWDP1K5VNKJOgk+jv7CXRQ2ePam2pmBMu824jyED3zQb6WuWEAwmMDYiJ3LOBE/IssMmmVZznkBCOwAFez2W/V+L5VKy3M6U5j8gicggtzOQtjqfNBnTASTc6JAcHPxqJJlWMX6OBRBEYRcR+Rud49GA1kp3QTlSuUiIVJZUEqrdeNTzXx1sJ9IiEwliQM9BexQRGUiSS7jLIMZS6QaJiuNcb3DXG4Z9Y20C7JjjXCNGvPN8u8UMvMYu1rKpy9BN3IY5iwjd4ElStcm1tBHS5igkd0z/u51YJXDuwPn7p2BySiMaX34+rW8ry0+jch0j9DjXguz8Q94eX5AhnVmbRf2+UDETM2VsdLh3eNhnGe/P9/u1Av11BfpDSobDoSRk5x0Z0kEVtW4yIq+BadDkt8HR0fH5+eji04fjj0PqbnmVkmcLO1MyULMZaBTlaaa0rfPaDOVQ1rcB8qoZxrKwhXqQp6HpeRkzYAlo86pYwTSkERnSCteQkj8IizGoR1bdgCyHcnsoM82l3ap13MUw3treDlG/Z3N27uInQN4aXLpJSYPgG8DslnFLJmDjmcP7dLRFC3JUf5NVfyL2r7VLC4/7wsH+6neU+IM2eDmUXu+EWdbovGKRapESsCvUdAuXbr90l70U7ExV0e+eV7DvoA9BhJZzmewzIddo2E770NUcPsVpksAchMpSkLbiBOc3L6jItLIqVqKM+v0CRZVRgcFZrkk7yo1VaS0CXyU0R+qsu1Inxne3E+ZqtFMTu/HqNl994o9BXmjLf3dxcUYaOWWPojZteQ3eNeXOPdnhHLYlRGlycuYeArBLbwnpNFW1360uS/RY7ZNzpGoP0tFeQccuXt7Ufez7LxfoI7cMH3nc7PKy4UCXPdw80jDR4HvXnxHinhMmav0GcZ5noA2EvWYwhLHj1833vUmMTZmrQ1ULh4+ANV68/WqySsmt84Lytun9sNLbwp3tZ4Jx1wq6kCuq4L+iLOOo3T4NqotvpNcqAkaLD4crWhRjZuBSi7LEYX9BwtTYqOMmfW5g4V5jmhdC6nK1DmxX4nrUk4g7wW8YxDE4Rqt3rVX4Vsa/PUbXYvMTlPXGwdWf4CWRyUUguyj8Cs9KmJVeCUfO7t2w/BcEkpbh +sidebar_class_name: "get api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Get a list of models + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-export.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-export.tag.mdx index f081ae4a9b6..d3a77271f14 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-export.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-export.tag.mdx @@ -5,7 +5,7 @@ description: "Import/export" custom_edit_url: null --- -Import and export Superset assets (dashboards, charts, databases). +Import and export Superset assets. | Method | Endpoint | Path | |--------|----------|------| diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.RequestSchema.json new file mode 100644 index 00000000000..75ba9da0b05 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"format":"binary","type":"string"},"overwrite":{"type":"string"}},"type":"object"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.StatusCodes.json new file mode 100644 index 00000000000..8144869c29c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"string"}}},"description":"Theme imported"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.api.mdx new file mode 100644 index 00000000000..c0783de61f6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/import-themes-from-a-zip-file.api.mdx @@ -0,0 +1,66 @@ +--- +id: import-themes-from-a-zip-file +title: "Import themes from a ZIP file" +description: "Import themes from a ZIP file" +sidebar_label: "Import themes from a ZIP file" +hide_title: true +hide_table_of_contents: true +api: eJzFV21P5DYQ/ivWqNKBGlg4tRLyiQ9A73TQ04G6S1uVIM6bzJKAY/tsZyGN8t+rsbPZF7bV9b7waR17Zvw8z4zH3hYsfq3R+VOdN8BbyLTyqDwNq1r60gjrRzNtq71ceEHTLiuwCiNjtUHrS3T0RUa/9DY0Fh44TEslbAMJ+MYgcHDeluoeugT0HO2TLT2S/cZqN9jr6QNmHjqaIqSlxRy4tzWGCWe0cnH7twcHG/iFMbLMhC+1Gj04rf4LfIXOiftvw5IAPovKSFxzXDp0CeToMlsa2ho4TAqskJWV0dZjTgF+em2wpyJnfeY5O1dzIcucGWFFhR6tY8bqeZkT2Jd0Vnwjl8PX5XKtRO0Lbcu/MefspPYFKt/vz4ai2UJk1TEwefv2tZkYqzP6nEpkxMI3nP1OyYls0Fptt1E507XMmdKe9RF6b9rq59cutnPl0SohmUM7RxtZcHaiWK3w2WDmMY+TTGdZbf8lXR+EF3KQIAGHWW2JI79p4eHJA7+57W4T8OLeAb+Jx87BbQLPe5nOcRyguWAuhboHDtn1b58gASmmKJefTtc2I+BZbSXb+5NdXY4nLIXCe8NHI6kzIQvtPD86ODoaCVOO5ocjT7uN4iEfpcDSNFWM7X1kKZz0VRYE5+wUhUXLfjg5O3s/Ht9NLn99/3nd4Symam/SGORsM1tL25y9aVN4xCYFzlKYC1ljCt0b6JKB4lXjC61WSA4TA80IenGmXapStWit7HiY3jfa+R3al/1PLZLoVKDI0brjdkORCL5XJQX2IxMZlfCd14+out6bmB9vY5uq3VQZWyq/s0C9T8Y7u7urOlyIuRiHalrRYm1ymXatHMkxSCCeROnZDH1WBAG+g34bWVToC50TfKqpTWn4woxtVg1R/rIonDbqMwnyfEmWLqt1E0V6WTvReqHqVOcNZxfjy8/78ViXs2anZY/YrEjMul2yJqXfpSqqQ6+BQZkN3XsjLXFf6vsdMt19B3Q01w/0eay7IJdjM6srJthf51dsVkqEBKJYwIEqDxIwwhfAYavMlL/QXeL5ri2ld2uWYBPGJ1pmOc5RalOh8n2fCtUTA7XGaq8zLTs+GrUUquMt7du9iHZWO6+rRYgE5sKW1M5d31pDGBrnOBO19D1MSABVXVHf6j/pJ3Sv9fgfJ5MrNsTpEiA06/EGvi/AjWMDpjUlKmTasvMrCkJc1oNslar3D9ZdRxldNOFxFrst71txC9NQrR8WL8GLPyaUo2BGD8OwunwYBtJdQs53FmcWXfG9QboESjXTkc4a+tqgdUiy+NLTLbU6RbUT7eaHURLnKxHuRtLqG+p1bbfhuvT47EdGilJR1FBPbV/KNyBMSVsfEqRAKum7MSRAuY/JvYG2nQqH11Z2HU1/rdHSvXe7rK9w+yUQO0k4A4/YhJfBsieEcpQ1odr2uKd6j04nWYahJy7MX7wYKPfD+aReBglM+/8Qlc7JhwKHuMlyGEHSs2tFoSGN/YDA90tCNSso2jZaxM5HZy/CDRcFdLdd1/0DL/JmaA== +sidebar_class_name: "post api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Import themes from a ZIP file + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/row-level-security.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/row-level-security.tag.mdx index 8a8a34f8710..1eb5d89976c 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/row-level-security.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/row-level-security.tag.mdx @@ -5,7 +5,7 @@ description: "Row Level Security" custom_edit_url: null --- -Manage row-level security rules for data access control. +Manage row-level security rules for data access. | Method | Endpoint | Path | |--------|----------|------| diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetresponseschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetresponseschema.Schema.json new file mode 100644 index 00000000000..3a752b61434 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetresponseschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"cache_timeout":{"type":"string"},"certification_details":{"type":"string"},"certified_by":{"type":"string"},"changed_on_delta_humanized":{"type":"string"},"dashboards":{"items":{"properties":{"dashboard_title":{"type":"string"},"id":{"type":"integer"},"json_metadata":{"type":"string"}},"type":"object","title":"Dashboard"},"type":"array"},"datasource_id":{"type":"integer"},"datasource_name_text":{"readOnly":true},"datasource_type":{"type":"string"},"datasource_url":{"readOnly":true},"datasource_uuid":{"format":"uuid","type":"string"},"description":{"type":"string"},"id":{"description":"The id of the chart.","type":"integer"},"is_managed_externally":{"type":"boolean"},"owners":{"items":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object","title":"User"},"type":"array"},"params":{"type":"string"},"query_context":{"type":"string"},"slice_name":{"type":"string"},"tags":{"items":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"Tag"},"type":"array"},"thumbnail_url":{"type":"string"},"url":{"type":"string"},"uuid":{"format":"uuid","type":"string"},"viz_type":{"type":"string"}},"type":"object","title":"ChartGetResponseSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetresponseschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetresponseschema.schema.mdx new file mode 100644 index 00000000000..b77aa15f54e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/chartgetresponseschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: chartgetresponseschema +title: "ChartGetResponseSchema" +description: "" +sidebar_label: "ChartGetResponseSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"cache_timeout":"string","certification_details":"string","certified_by":"string","changed_on_delta_humanized":"string","dashboards":[{"dashboard_title":"string","id":0,"json_metadata":"string"}],"datasource_id":0,"datasource_type":"string","datasource_uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","description":"string","id":0,"is_managed_externally":true,"owners":[{"first_name":"string","id":0,"last_name":"string"}],"params":"string","query_context":"string","slice_name":"string","tags":[{"id":0,"name":"string"}],"thumbnail_url":"string","url":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6","viz_type":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/currentuserputschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/currentuserputschema.Schema.json new file mode 100644 index 00000000000..2febad910c9 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/currentuserputschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"description":"The current user's first name","maxLength":64,"minLength":1,"type":"string"},"last_name":{"description":"The current user's last name","maxLength":64,"minLength":1,"type":"string"},"password":{"description":"The current user's password for authentication","type":"string"}},"type":"object","title":"CurrentUserPutSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/currentuserputschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/currentuserputschema.schema.mdx new file mode 100644 index 00000000000..fa7737ac3e7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/currentuserputschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: currentuserputschema +title: "CurrentUserPutSchema" +description: "" +sidebar_label: "CurrentUserPutSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string","password":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboard.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboard.Schema.json new file mode 100644 index 00000000000..e15e7dd1f42 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboard.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"dashboard_title":{"type":"string"},"id":{"type":"integer"},"json_metadata":{"type":"string"}},"type":"object","title":"Dashboard"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboard.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboard.schema.mdx new file mode 100644 index 00000000000..966bd4cc295 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboard.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboard +title: "Dashboard" +description: "" +sidebar_label: "Dashboard" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"dashboard_title":"string","id":0,"json_metadata":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardchartcustomizationsconfigupdateschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardchartcustomizationsconfigupdateschema.Schema.json new file mode 100644 index 00000000000..6184b78731c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardchartcustomizationsconfigupdateschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"type":"object","properties":{"deleted":{"type":"array","items":{"type":"string"},"description":"List of deleted chart customization IDs."},"modified":{"type":"array","items":{"type":"object"},"description":"List of modified chart customization configurations."},"reordered":{"type":"array","items":{"type":"string"},"description":"List of chart customization IDs in new order."}},"title":"DashboardChartCustomizationsConfigUpdateSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardchartcustomizationsconfigupdateschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardchartcustomizationsconfigupdateschema.schema.mdx new file mode 100644 index 00000000000..15c233e729a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/dashboardchartcustomizationsconfigupdateschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: dashboardchartcustomizationsconfigupdateschema +title: "DashboardChartCustomizationsConfigUpdateSchema" +description: "" +sidebar_label: "DashboardChartCustomizationsConfigUpdateSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"deleted":["string"],"modified":[{}],"reordered":["string"]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetriccurrencyput.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetriccurrencyput.Schema.json new file mode 100644 index 00000000000..f7d0d1f17db --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetriccurrencyput.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"symbol":{"maxLength":128,"minLength":1,"type":"string"},"symbolPosition":{"maxLength":128,"minLength":1,"type":"string"}},"type":"object","title":"DatasetMetricCurrencyPut"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetriccurrencyput.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetriccurrencyput.schema.mdx new file mode 100644 index 00000000000..43600c0014f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/datasetmetriccurrencyput.schema.mdx @@ -0,0 +1,31 @@ +--- +id: datasetmetriccurrencyput +title: "DatasetMetricCurrencyPut" +description: "" +sidebar_label: "DatasetMetricCurrencyPut" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"symbol":"string","symbolPosition":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list-role.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list-role.Schema.json new file mode 100644 index 00000000000..ec0a0adcdcc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list-role.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"GroupApi.get_list.Role"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list-role.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list-role.schema.mdx new file mode 100644 index 00000000000..18aa154b32a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list-role.schema.mdx @@ -0,0 +1,31 @@ +--- +id: groupapi-get-list-role +title: "GroupApi.get_list.Role" +description: "" +sidebar_label: "GroupApi.get_list.Role" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list-user.Schema.json new file mode 100644 index 00000000000..d5eabd64529 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"username":{"maxLength":128,"type":"string"}},"required":["username"],"type":"object","title":"GroupApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..954133e64c8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: groupapi-get-list-user +title: "GroupApi.get_list.User" +description: "" +sidebar_label: "GroupApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list.Schema.json new file mode 100644 index 00000000000..8b7567d8848 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"description":{"maxLength":512,"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":150,"nullable":true,"type":"string"},"name":{"maxLength":100,"type":"string"},"roles":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"GroupApi.get_list.Role"},"users":{"properties":{"id":{"type":"integer"},"username":{"maxLength":128,"type":"string"}},"required":["username"],"type":"object","title":"GroupApi.get_list.User"}},"required":["name"],"type":"object","title":"GroupApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list.schema.mdx new file mode 100644 index 00000000000..1155cfa6a05 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: groupapi-get-list +title: "GroupApi.get_list" +description: "" +sidebar_label: "GroupApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"description":"string","id":0,"label":"string","name":"string","roles":{"id":0,"name":"string"},"users":{"id":0,"username":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-role.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-role.Schema.json new file mode 100644 index 00000000000..c7459675a14 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-role.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"GroupApi.get.Role"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-role.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-role.schema.mdx new file mode 100644 index 00000000000..ae5dd3615f7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-role.schema.mdx @@ -0,0 +1,31 @@ +--- +id: groupapi-get-role +title: "GroupApi.get.Role" +description: "" +sidebar_label: "GroupApi.get.Role" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-user.Schema.json new file mode 100644 index 00000000000..22fd8dc3e85 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"username":{"maxLength":128,"type":"string"}},"required":["username"],"type":"object","title":"GroupApi.get.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-user.schema.mdx new file mode 100644 index 00000000000..07ee6d3b60b --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: groupapi-get-user +title: "GroupApi.get.User" +description: "" +sidebar_label: "GroupApi.get.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get.Schema.json new file mode 100644 index 00000000000..8224e5ff71a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"description":{"maxLength":512,"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":150,"nullable":true,"type":"string"},"name":{"maxLength":100,"type":"string"},"roles":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object","title":"GroupApi.get.Role"},"users":{"properties":{"id":{"type":"integer"},"username":{"maxLength":128,"type":"string"}},"required":["username"],"type":"object","title":"GroupApi.get.User"}},"required":["name"],"type":"object","title":"GroupApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get.schema.mdx new file mode 100644 index 00000000000..d0c11c49d7c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: groupapi-get +title: "GroupApi.get" +description: "" +sidebar_label: "GroupApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"description":"string","id":0,"label":"string","name":"string","roles":{"id":0,"name":"string"},"users":{"id":0,"username":"string"}} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-post.Schema.json new file mode 100644 index 00000000000..e63133205e2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"description":{"description":"Group description","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"label":{"description":"Group label","maxLength":150,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"Group name","maxLength":100,"minLength":1,"type":"string"},"roles":{"description":"Group roles","items":{"type":"integer"},"type":"array"},"users":{"description":"Group users","items":{"type":"integer"},"type":"array"}},"required":["name"],"type":"object","title":"GroupApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-post.schema.mdx new file mode 100644 index 00000000000..1792928805d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: groupapi-post +title: "GroupApi.post" +description: "" +sidebar_label: "GroupApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"description":"string","label":"string","name":"string","roles":[0],"users":[0]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-put.Schema.json new file mode 100644 index 00000000000..31cf9d5821d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"description":{"description":"Group description","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"label":{"description":"Group label","maxLength":150,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"Group name","maxLength":100,"minLength":1,"type":"string"},"roles":{"description":"Group roles","items":{"type":"integer"},"type":"array"},"users":{"description":"Group users","items":{"type":"integer"},"type":"array"}},"type":"object","title":"GroupApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-put.schema.mdx new file mode 100644 index 00000000000..766274227bc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: groupapi-put +title: "GroupApi.put" +description: "" +sidebar_label: "GroupApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"description":"string","label":"string","name":"string","roles":[0],"users":[0]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/grouppostschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/grouppostschema.Schema.json new file mode 100644 index 00000000000..862253cb8c4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/grouppostschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"description":{"description":"Group description","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"label":{"description":"Group label","maxLength":150,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"Group name","maxLength":100,"minLength":1,"type":"string"},"roles":{"description":"Group roles","items":{"type":"integer"},"type":"array"},"users":{"description":"Group users","items":{"type":"integer"},"type":"array"}},"required":["name"],"type":"object","title":"GroupPostSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/grouppostschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/grouppostschema.schema.mdx new file mode 100644 index 00000000000..640731d7e42 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/grouppostschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: grouppostschema +title: "GroupPostSchema" +description: "" +sidebar_label: "GroupPostSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"description":"string","label":"string","name":"string","roles":[0],"users":[0]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupputschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupputschema.Schema.json new file mode 100644 index 00000000000..9432e2fbb9d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupputschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"description":{"description":"Group description","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"label":{"description":"Group label","maxLength":150,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"Group name","maxLength":100,"minLength":1,"type":"string"},"roles":{"description":"Group roles","items":{"type":"integer"},"type":"array"},"users":{"description":"Group users","items":{"type":"integer"},"type":"array"}},"type":"object","title":"GroupPutSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupputschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupputschema.schema.mdx new file mode 100644 index 00000000000..e2cb35aace4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/groupputschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: groupputschema +title: "GroupPutSchema" +description: "" +sidebar_label: "GroupPutSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"description":"string","label":"string","name":"string","roles":[0],"users":[0]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolegroupputschema.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolegroupputschema.Schema.json new file mode 100644 index 00000000000..8cf5234dc27 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolegroupputschema.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"group_ids":{"description":"List of group ids","items":{"type":"integer"},"type":"array"}},"required":["group_ids"],"type":"object","title":"RoleGroupPutSchema"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolegroupputschema.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolegroupputschema.schema.mdx new file mode 100644 index 00000000000..34eeabe5fba --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/rolegroupputschema.schema.mdx @@ -0,0 +1,31 @@ +--- +id: rolegroupputschema +title: "RoleGroupPutSchema" +description: "" +sidebar_label: "RoleGroupPutSchema" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"group_ids":[0]} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-group.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-group.Schema.json new file mode 100644 index 00000000000..9515107ca17 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-group.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"description":{"maxLength":512,"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":150,"nullable":true,"type":"string"},"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"SupersetUserApi.get.Group"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-group.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-group.schema.mdx new file mode 100644 index 00000000000..3e16db094e5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-group.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetuserapi-get-group +title: "SupersetUserApi.get.Group" +description: "" +sidebar_label: "SupersetUserApi.get.Group" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"description":"string","id":0,"label":"string","name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-group.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-group.Schema.json new file mode 100644 index 00000000000..04df8d6dcb1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-group.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"description":{"maxLength":512,"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":150,"nullable":true,"type":"string"},"name":{"maxLength":100,"type":"string"}},"required":["name"],"type":"object","title":"SupersetUserApi.get_list.Group"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-group.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-group.schema.mdx new file mode 100644 index 00000000000..8aaf1ec2af8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/supersetuserapi-get-list-group.schema.mdx @@ -0,0 +1,31 @@ +--- +id: supersetuserapi-get-list-group +title: "SupersetUserApi.get_list.Group" +description: "" +sidebar_label: "SupersetUserApi.get_list.Group" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"description":"string","id":0,"label":"string","name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tag-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tag-1.Schema.json new file mode 100644 index 00000000000..9a0806aac0f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tag-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object","title":"Tag1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tag-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tag-1.schema.mdx new file mode 100644 index 00000000000..a97fe15858a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/tag-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: tag-1 +title: "Tag1" +description: "" +sidebar_label: "Tag1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/theme.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/theme.Schema.json new file mode 100644 index 00000000000..03c1fa22258 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/theme.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"},"json_data":{"type":"string"},"theme_name":{"type":"string"}},"type":"object","title":"Theme"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/theme.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/theme.schema.mdx new file mode 100644 index 00000000000..c84592303a0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/theme.schema.mdx @@ -0,0 +1,31 @@ +--- +id: theme +title: "Theme" +description: "" +sidebar_label: "Theme" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0,"json_data":"string","theme_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list-user-1.Schema.json new file mode 100644 index 00000000000..217f894f1b5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ThemeRestApi.get_list.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list-user-1.schema.mdx new file mode 100644 index 00000000000..0f6efe1469e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: themerestapi-get-list-user-1 +title: "ThemeRestApi.get_list.User1" +description: "" +sidebar_label: "ThemeRestApi.get_list.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list-user.Schema.json new file mode 100644 index 00000000000..65aeb738ea7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ThemeRestApi.get_list.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list-user.schema.mdx new file mode 100644 index 00000000000..899fd1d5b91 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: themerestapi-get-list-user +title: "ThemeRestApi.get_list.User" +description: "" +sidebar_label: "ThemeRestApi.get_list.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list.Schema.json new file mode 100644 index 00000000000..9de0a4c140d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ThemeRestApi.get_list.User"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ThemeRestApi.get_list.User1"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"is_system":{"type":"boolean"},"is_system_dark":{"type":"boolean"},"is_system_default":{"type":"boolean"},"json_data":{"nullable":true,"type":"string"},"theme_name":{"maxLength":250,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"type":"object","title":"ThemeRestApi.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list.schema.mdx new file mode 100644 index 00000000000..1709c2b8bf1 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: themerestapi-get-list +title: "ThemeRestApi.get_list" +description: "" +sidebar_label: "ThemeRestApi.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_by":{"first_name":"string","id":0,"last_name":"string"},"created_by":{"first_name":"string","id":0,"last_name":"string"},"created_on":"2024-07-29T15:51:28.071Z","id":0,"is_system":true,"is_system_dark":true,"is_system_default":true,"json_data":"string","theme_name":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-user-1.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-user-1.Schema.json new file mode 100644 index 00000000000..6f7818d3987 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-user-1.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ThemeRestApi.get.User1"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-user-1.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-user-1.schema.mdx new file mode 100644 index 00000000000..d03c318a6d5 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-user-1.schema.mdx @@ -0,0 +1,31 @@ +--- +id: themerestapi-get-user-1 +title: "ThemeRestApi.get.User1" +description: "" +sidebar_label: "ThemeRestApi.get.User1" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-user.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-user.Schema.json new file mode 100644 index 00000000000..98024ace579 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-user.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ThemeRestApi.get.User"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-user.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-user.schema.mdx new file mode 100644 index 00000000000..da7f587a025 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get-user.schema.mdx @@ -0,0 +1,31 @@ +--- +id: themerestapi-get-user +title: "ThemeRestApi.get.User" +description: "" +sidebar_label: "ThemeRestApi.get.User" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","id":0,"last_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get.Schema.json new file mode 100644 index 00000000000..dfb49136652 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"changed_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ThemeRestApi.get.User"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object","title":"ThemeRestApi.get.User1"},"id":{"type":"integer"},"is_system":{"type":"boolean"},"is_system_dark":{"type":"boolean"},"is_system_default":{"type":"boolean"},"json_data":{"nullable":true,"type":"string"},"theme_name":{"maxLength":250,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"type":"object","title":"ThemeRestApi.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get.schema.mdx new file mode 100644 index 00000000000..1e92175cff2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: themerestapi-get +title: "ThemeRestApi.get" +description: "" +sidebar_label: "ThemeRestApi.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"changed_by":{"first_name":"string","id":0,"last_name":"string"},"created_by":{"first_name":"string","id":0,"last_name":"string"},"id":0,"is_system":true,"is_system_dark":true,"is_system_default":true,"json_data":"string","theme_name":"string","uuid":"3fa85f64-5717-4562-b3fc-2c963f66afa6"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-post.Schema.json new file mode 100644 index 00000000000..53c3537b4be --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"json_data":{"type":"string"},"theme_name":{"type":"string"}},"required":["json_data","theme_name"],"type":"object","title":"ThemeRestApi.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-post.schema.mdx new file mode 100644 index 00000000000..b0f8c1d0b83 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: themerestapi-post +title: "ThemeRestApi.post" +description: "" +sidebar_label: "ThemeRestApi.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"json_data":"string","theme_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-put.Schema.json new file mode 100644 index 00000000000..795ee3a836d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"json_data":{"type":"string"},"theme_name":{"type":"string"}},"required":["json_data","theme_name"],"type":"object","title":"ThemeRestApi.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-put.schema.mdx new file mode 100644 index 00000000000..57c1cc1aae3 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/themerestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: themerestapi-put +title: "ThemeRestApi.put" +description: "" +sidebar_label: "ThemeRestApi.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"json_data":"string","theme_name":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-3.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-3.Schema.json new file mode 100644 index 00000000000..eecff409a00 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-3.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object","title":"User3"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-3.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-3.schema.mdx new file mode 100644 index 00000000000..9b6fd3695d7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/user-3.schema.mdx @@ -0,0 +1,31 @@ +--- +id: user-3 +title: "User3" +description: "" +sidebar_label: "User3" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"first_name":"string","last_name":"string","username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-get-list.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-get-list.Schema.json new file mode 100644 index 00000000000..91ae85d412e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-get-list.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"email":{"maxLength":320,"type":"string"},"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"},"registration_date":{"format":"date-time","nullable":true,"type":"string"},"registration_hash":{"maxLength":256,"nullable":true,"type":"string"},"username":{"maxLength":128,"type":"string"}},"required":["email","first_name","last_name","username"],"type":"object","title":"UserRegistrationsRestAPI.get_list"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-get-list.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-get-list.schema.mdx new file mode 100644 index 00000000000..ccd60b9939d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-get-list.schema.mdx @@ -0,0 +1,31 @@ +--- +id: userregistrationsrestapi-get-list +title: "UserRegistrationsRestAPI.get_list" +description: "" +sidebar_label: "UserRegistrationsRestAPI.get_list" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"email":"string","first_name":"string","id":0,"last_name":"string","registration_date":"2024-07-29T15:51:28.071Z","registration_hash":"string","username":"string"} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-get.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-get.Schema.json new file mode 100644 index 00000000000..e7fa882518e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-get.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.get"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-get.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-get.schema.mdx new file mode 100644 index 00000000000..0980de95728 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-get.schema.mdx @@ -0,0 +1,31 @@ +--- +id: userregistrationsrestapi-get +title: "UserRegistrationsRestAPI.get" +description: "" +sidebar_label: "UserRegistrationsRestAPI.get" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-post.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-post.Schema.json new file mode 100644 index 00000000000..2a880c20cbf --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-post.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.post"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-post.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-post.schema.mdx new file mode 100644 index 00000000000..eb85977acd2 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-post.schema.mdx @@ -0,0 +1,31 @@ +--- +id: userregistrationsrestapi-post +title: "UserRegistrationsRestAPI.post" +description: "" +sidebar_label: "UserRegistrationsRestAPI.post" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-put.Schema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-put.Schema.json new file mode 100644 index 00000000000..a3c65dfa44c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-put.Schema.json @@ -0,0 +1 @@ +{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.put"},"schemaType":"response"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-put.schema.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-put.schema.mdx new file mode 100644 index 00000000000..7a8420e1557 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/schemas/userregistrationsrestapi-put.schema.mdx @@ -0,0 +1,31 @@ +--- +id: userregistrationsrestapi-put +title: "UserRegistrationsRestAPI.put" +description: "" +sidebar_label: "UserRegistrationsRestAPI.put" +hide_title: true +hide_table_of_contents: true +schema: true +sample: {"id":0} +custom_edit_url: null +--- + +import Schema from "@theme/Schema"; +import Heading from "@theme/Heading"; + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/security-groups.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-groups.tag.mdx new file mode 100644 index 00000000000..4815b9c8df6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-groups.tag.mdx @@ -0,0 +1,17 @@ +--- +id: security-groups +title: "Security Groups" +description: "Security Groups" +custom_edit_url: null +--- + +Endpoints related to Security Groups. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get security groups](./get-security-groups) | `/api/v1/security/groups/` | +| `POST` | [Create security groups](./create-security-groups) | `/api/v1/security/groups/` | +| `GET` | [Get security groups info](./get-security-groups-info) | `/api/v1/security/groups/_info` | +| `DELETE` | [Delete security groups by pk](./delete-security-groups-by-pk) | `/api/v1/security/groups/{pk}` | +| `GET` | [Get security groups by pk](./get-security-groups-by-pk) | `/api/v1/security/groups/{pk}` | +| `PUT` | [Update security groups by pk](./update-security-groups-by-pk) | `/api/v1/security/groups/{pk}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/security-permissions-on-resources-view-menus.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-permissions-on-resources-view-menus.tag.mdx index 1decc266dd9..26413e44e9e 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/security-permissions-on-resources-view-menus.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-permissions-on-resources-view-menus.tag.mdx @@ -5,7 +5,7 @@ description: "Security Permissions on Resources (View Menus)" custom_edit_url: null --- -Manage permission-resource mappings. +Permission-resource mappings. | Method | Endpoint | Path | |--------|----------|------| diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/security-roles.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-roles.tag.mdx index 8faa7f87807..d43900d38dd 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/security-roles.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/security-roles.tag.mdx @@ -15,6 +15,7 @@ Manage security roles and their permissions. | `DELETE` | [Delete security roles by pk](./delete-security-roles-by-pk) | `/api/v1/security/roles/{pk}` | | `GET` | [Get security roles by pk](./get-security-roles-by-pk) | `/api/v1/security/roles/{pk}` | | `PUT` | [Update security roles by pk](./update-security-roles-by-pk) | `/api/v1/security/roles/{pk}` | +| `PUT` | [Update security roles by role_id groups](./update-security-roles-by-role-id-groups) | `/api/v1/security/roles/{role_id}/groups` | | `POST` | [Create security roles by role_id permissions](./create-security-roles-by-role-id-permissions) | `/api/v1/security/roles/{role_id}/permissions` | | `GET` | [Get security roles by role_id permissions](./get-security-roles-by-role-id-permissions) | `/api/v1/security/roles/{role_id}/permissions/` | | `PUT` | [Update security roles by role_id users](./update-security-roles-by-role-id-users) | `/api/v1/security/roles/{role_id}/users` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.ParamsDetails.json new file mode 100644 index 00000000000..0b5dc554ec8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The theme id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.StatusCodes.json new file mode 100644 index 00000000000..69feef1b086 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"integer"},"result":{"type":"string"}},"type":"object"},"example":{"id":1,"result":"string"}}},"description":"Theme successfully set as system dark"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.api.mdx new file mode 100644 index 00000000000..751a1f3ab20 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-dark-theme.api.mdx @@ -0,0 +1,68 @@ +--- +id: set-a-theme-as-the-system-dark-theme +title: "Set a theme as the system dark theme" +description: "Set a theme as the system dark theme" +sidebar_label: "Set a theme as the system dark theme" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/iuHw4AlmBI3WQsEKvohDVq0WZEGtbMXREFKS+eIjUSyJOXGE/TfhyNl+SUesLUf8skWeXe657lXtWiEFTV5sg7T6xYLcrmVxkutMMVJSeBLqglkgQlKPjPCl5igEjXx0z0maOlrIy0VmHrbUIIuL6kWmLboF4alpPJ0Rxa77oalndHKkWOB42fP+CfXypPy/FcYU8lcsAejL47daNcMGqsNWS+jtix2vSS8oqn82p3zVqo77LpkeaKnXyj3LEwPojYVLe0drdRXal3ymJmawDV5Ts7NmqpagCMPwoFbOE81FMLes/XnPwSwJufEHf1/JIMivhYFcIDI+RTeq7moZAGrqIOxei4LKnahXNONWI6eFsuVEo0vtZV/U5HCaeNLUr5/PwxZuAPIumJE8uvTInmr7VQWBakU/tINFFr97KEUcwJDtpbOMSKvQYQEA19KB5acbmxOuwAO9iK650+L7kJ7mOlGFSlwC+lTiIoBAhSaHCjtgR4kJ9djRIONgOj4+Kkzz1jNoRDTioCzzi9S+J2LKWYfWavtLhxnuqmKALW30Gvzq148dXN4rzxZJSpwZOdkI4oUThU0ih4M5Ry0cAg6zxv7L+X1VnhRDRQk6ChvLGPkkfLlm8f0+oZbvxd3PGZi93R4k+DDQa4LGgfX4gSqhLrDFPOrTx8wwUpMqVo99gWQYt7YCg7+hMurCWRYem/S0ajSuahK7Xx68uzkZCSMHM2PRmGAjY5GjvxtbM633JwzhCzLFMDBO8jwtG8PgfkUXpOwZOGn07OzN+Px7eTjb28uMsQuGfy7XPhSqzUPh4PBR1kbbf0y+12mMrWcffBqOD40jd9jP+C7gSRRvSRRkHWv2i04GaaQYQ8pQ/il7yq3Xt+T6nptzjZWvadFVJiLqqEMu0ztZ8pYqfze0v1DFt7b318n5FzMxTjkxBopG4er4GnlmJeBC/FNSA8z8nkZqPghItqIpyZf6oKBXF5NtjlKl1KwHXvG/nkZ/jYSNQk8fU5WKmexYg8mC0ORre3CzTBKL+md6mKRwvn448VhrFI5W+y1cE+LNa6h22dppvxlpiJNhfBioGgrAL2Qruiw0nd7LLr/ErnSNutzzKtJv8kJnia0vqbEC0wwUsZbXcPxCpteipust+a+2yaeYxv6R6zgxnLod0YQtz37wNdQ0JwqbWpSvu9EIbOiodZY7XWuqy4djVo21aUtV1b3yNpZ47yulyYSnAsruWG7vnkGM/y/oJmIKx67iQmSamruTP0j/4T+tGn/3WRyCYOdLkH2ZtPegPeRc+PYYvmOl2fQFt5fshHGsmlkJ1W9fpDuwia9bLPjPPbTtG+2LU5DAr/VthZs7/yPCfZrOddfvMVhSATQXcLKt5Zmllz5vUY6/kqY6Qhnw/vGkHXEtHjpeQ6tH3HuRLn5UaTE+VqE6dd/aPzHFN546TAXPT34kamEDOtRSKu2T+9rFEayB0fsWW8lNTGnN7P8Zhnva2zbqXB0Zauu4+OvDVkedjerlItfUzLsCwWmM1E5euTeMPhx71O/ve7D1kfXTgj9oVCLkOVVw0+YcPOOH2XdDWdnaHbBk3hxmucUWvFS5dG6wWk1tIHLK444b85rXA5x7/+w9Z3utG2UiN2zG7wLU4cd7Lp/ACPD/qs= +sidebar_class_name: "put api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Set a theme as the system dark theme + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.ParamsDetails.json new file mode 100644 index 00000000000..0b5dc554ec8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The theme id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.RequestSchema.json new file mode 100644 index 00000000000..188a349c40f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body"} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.StatusCodes.json new file mode 100644 index 00000000000..8060db9789d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"integer"},"result":{"type":"string"}},"type":"object"},"example":{"id":1,"result":"string"}}},"description":"Theme successfully set as system default"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.api.mdx new file mode 100644 index 00000000000..2fd3d333c37 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/set-a-theme-as-the-system-default-theme.api.mdx @@ -0,0 +1,68 @@ +--- +id: set-a-theme-as-the-system-default-theme +title: "Set a theme as the system default theme" +description: "Set a theme as the system default theme" +sidebar_label: "Set a theme as the system default theme" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/iuHw4AlmBI3XQcUKvohDVq0XZEGtbMXREFKS+eIjUSyJOXGE/TfhyMl+SUesK0f8skWdXe657lXtmiEFTV5sg7TqxYLcrmVxkutMMVZSeBLqglkgQlKPjPCl5igEjXx0x0maOlrIy0VmHrbUIIuL6kWmLboV4alpPJ0Sxa77pqlndHKkWOBp0+e8E+ulSfl+a8wppK5YA8mXxy70W4YNFYbsl5GbVns+0j4RFP5jXfOW6luseuS4UTPv1DuWZjuRW0qGuydrNXXal3ykJmawDV5Ts4tmqpagSMPwoFbOU81FLQQbKRL8Nl3YazJOXFL/x3MqIivRAEcI3I+hXdqKSpZwDrwYKxeyoKKfUA3dCOWk8fFcqlE40tt5V9UpHDa+JKU778PYyLuAbKpGJH8/LhI3mg7l0VBKoU/dQOFVj96KMWSwJCtpXOMyGsQIcfAl9KBJacbm9M+gKO9iO7Z46I71x4WulFFCtxF+hSiYoQAhSYHSnuge8nJ9RDRaCMgevr0sTPPWM2hEPOKgLPOr1L4jYspZh9Zq+0+HGe6qYoAtbfQa/Onfnns5vBOebJKVODILslGFCmcKmgU3RvKOWjhEHSeN/YfyuuN8KIaKUjQUd5YxshT5cs3j+nVNXd/L2550sQG6vA6wfujXBc0Da7FIVQJdYsp5pefPmCClZhTtX7sCyDFvLEVHP0BF5czyLD03qSTSaVzUZXa+fT5k+fPJ8LIyfJkEmbY5GTiyN/E/nzT9+cMIcsyBXD0FjI87TtEID+FVyQsWfjh9Ozs9XR6M/v46+vzDLFLRhcvVr7UasPJ8WB0U9ZGWz8UgMtUpoYJCC/H42PT+AP2A74HSxItlCQKsu5lu4MowxQy7FFlCD/1veXG6ztSXa/NOceqd7SKCktRNZRhl6nDTBkrlT8YEByz8MHh4SYn78VSTENmbPCydbgOoVaOqRnpEN+E9LAgn5eBje/loo2QavKlLhjLxeVsl6Z0kILdDGD4n4ckaCNXs0DV52StchZL92i2MhQJ263gDKP0wPBcF6sU3k8/nh/HcpWL1UELd7TaoBu6Q5Zm1l9kKjJVCC9GlnZi0Avpio4rfXvAoocvkEtuu1CnvKb0W53gsUI7K0t8hwlG1njJazhqYfFLcZv71tx1e+jnIId2Egu6sZwDe0OJu/594NdQ0JIqbWpSvm9MIcWiodZY7XWuqy6dTFo21aUtV1n3wNpZ47yuBxMJLoWV3L9d30uDGf4/OB7dxARJNTU3qv6Rf0K72rb/dja7gNFOlyB7s21vxPvAuWnsuPyO12nQFt5dsBHGsm1kL1W9fpDuwm49dN1pHttr2vfeFuchjd9oWwu29/73GfaLOhdifIvjzAigu4SVbywtLLny/xrp+N6w0BHOlveNIeuIafHS81jaPOLciXLLk0iJ87UIw7C/evz7RN767jgpPd37iamEDAtTyKy2T/IrFEayEyfsXG8lDXedPbl+PUT9Ctt2Lhxd2qrr+PhrQ5Yn4PU68eItS4YlosB0ISpHDzwctwE8+NSvtIewcxnbi6I/FGoVcr1q+AkT7uXxstZdc46Gxhc8iS9O85xCZx5UHuwgnFxjP7i45LjzOr1B5xj9/g9b3+tO20aJ2Em70bswhNjBrvsbSfUI0g== +sidebar_class_name: "put api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Set a theme as the system default theme + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab-permanent-link.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab-permanent-link.tag.mdx index 2dd6fbc6743..f9ea58f7e61 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab-permanent-link.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab-permanent-link.tag.mdx @@ -5,7 +5,7 @@ description: "SQL Lab Permanent Link" custom_edit_url: null --- -Create and retrieve permanent links to SQL Lab states. +Permanent links to SQL Lab states. | Method | Endpoint | Path | |--------|----------|------| diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab.tag.mdx index 9b0e9418c4d..5699ee701ce 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab.tag.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/sql-lab.tag.mdx @@ -12,6 +12,7 @@ Execute SQL queries and manage SQL Lab sessions. | `GET` | [Get the bootstrap data for SqlLab page](./get-the-bootstrap-data-for-sql-lab-page) | `/api/v1/sqllab/` | | `POST` | [Estimate the SQL query execution cost](./estimate-the-sql-query-execution-cost) | `/api/v1/sqllab/estimate/` | | `POST` | [Execute a SQL query](./execute-a-sql-query) | `/api/v1/sqllab/execute/` | +| `POST` | [Export SQL query results to CSV with streaming](./export-sql-query-results-to-csv-with-streaming) | `/api/v1/sqllab/export_streaming/` | | `GET` | [Export the SQL query results to a CSV](./export-the-sql-query-results-to-a-csv) | `/api/v1/sqllab/export/{client_id}/` | | `POST` | [Format SQL code](./format-sql-code) | `/api/v1/sqllab/format_sql/` | | `GET` | [Get the result of a SQL query execution](./get-the-result-of-a-sql-query-execution) | `/api/v1/sqllab/results/` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/themes.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/themes.tag.mdx new file mode 100644 index 00000000000..42612909c9f --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/themes.tag.mdx @@ -0,0 +1,25 @@ +--- +id: themes +title: "Themes" +description: "Themes" +custom_edit_url: null +--- + +Manage UI themes for customizing Superset's appearance. + +| Method | Endpoint | Path | +|--------|----------|------| +| `DELETE` | [Bulk delete themes](./bulk-delete-themes) | `/api/v1/theme/` | +| `GET` | [Get a list of themes](./get-a-list-of-themes) | `/api/v1/theme/` | +| `POST` | [Create a theme](./create-a-theme) | `/api/v1/theme/` | +| `GET` | [Get metadata information about this API resource (theme--info)](./get-metadata-information-about-this-api-resource-theme-info) | `/api/v1/theme/_info` | +| `DELETE` | [Delete a theme](./delete-a-theme) | `/api/v1/theme/{pk}` | +| `GET` | [Get a theme](./get-a-theme) | `/api/v1/theme/{pk}` | +| `PUT` | [Update a theme](./update-a-theme) | `/api/v1/theme/{pk}` | +| `PUT` | [Set a theme as the system dark theme](./set-a-theme-as-the-system-dark-theme) | `/api/v1/theme/{pk}/set_system_dark` | +| `PUT` | [Set a theme as the system default theme](./set-a-theme-as-the-system-default-theme) | `/api/v1/theme/{pk}/set_system_default` | +| `GET` | [Download multiple themes as YAML files](./download-multiple-themes-as-yaml-files) | `/api/v1/theme/export/` | +| `POST` | [Import themes from a ZIP file](./import-themes-from-a-zip-file) | `/api/v1/theme/import/` | +| `GET` | [Get related fields data (theme-related-column-name)](./get-related-fields-data-theme-related-column-name) | `/api/v1/theme/related/{column_name}` | +| `DELETE` | [Clear the system dark theme](./clear-the-system-dark-theme) | `/api/v1/theme/unset_system_dark` | +| `DELETE` | [Clear the system default theme](./clear-the-system-default-theme) | `/api/v1/theme/unset_system_default` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.RequestSchema.json new file mode 100644 index 00000000000..ed296b95b42 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"json_data":{"type":"string"},"theme_name":{"type":"string"}},"required":["json_data","theme_name"],"type":"object","title":"ThemeRestApi.put"},"example":{"json_data":"string","theme_name":"string"}}},"description":"Theme schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.StatusCodes.json new file mode 100644 index 00000000000..ae64ea21897 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"properties":{"json_data":{"type":"string"},"theme_name":{"type":"string"}},"required":["json_data","theme_name"],"type":"object","title":"ThemeRestApi.put"}},"type":"object"},"example":{"id":1,"result":{"json_data":"string","theme_name":"string"}}}},"description":"Theme updated"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.api.mdx new file mode 100644 index 00000000000..626c422cf8c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-a-theme.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-a-theme +title: "Update a theme" +description: "Update a theme" +sidebar_label: "Update a theme" +hide_title: true +hide_table_of_contents: true +api: eJzNV21v2zYQ/ivEYUATTImbrgMKFf2QBi3arkiD2NkLoiClxXPERiJZknLiCfrvw5GyLL9kWNsP2Sdb5N3xnudeeGzAcMsr9GgdpJcNSAUpGO4LSEDxCunrFhKw+LWWFgWk3taYgMsLrDikDfiFISmpPN6ghba9itLo/GstFiSSa+VRefrLjSllzr3UavTFaUVrK1vGaoPWS3T0RfvXgvvhMc5bqW6gTcAXWOF19HFrux16fDmwtKZ3lSz19PQL5p52pS9pYUJS5+j8sZGHpvZ0It7zypS44dryzHWPVp60CQh0uZWGQC9Nsw70JrPBcWe0cpGDZ0+f/gCDUgy4UXU1pQCFE+rS/98JbzeF10NA2I6GWL4lJg8EpTaCexR00vMfIr5C5/jNA0T9G6peEV5zwbo6Stl7NeelFGxVrcxYPZeCnN1GM9CNWI4eF8uF4rUvtJV/o0jZce0LVL47n/V5swPIUDEi+eVxkbzVdiqFQJWyv3TNhFZPPCv4HJlBW0nnCJHXjOc5Osd8IR2z6HRtc9wFsLcX0T1/XHSn2rOZrpVI2aTAZQqh6CEwodExpT3De0nJtY2otxEQPXv22JlnrKZQ8GmJjLLOL1L2OxVTzD60VttdOE50XYoAtbPQadNRvz52c3ivPFrFS+bQztFGFCk7VqxWeG8wp6CFRabzvLYPlNdb7nnZU5CAw7y2hJFGgS93HtLLK7rPPb+h8SB2SUdt/P4g1wLHwbU4OZRc3UAK+cX5R0ig5FMsV59dAaSQ17ZkB3+ys4sJy6Dw3qSjUalzXhba+fTF0xcvRtzI0fxoFFr36CgDlmWZYuzgHcvguGsHgemUvUZu0bKfjk9O3ozH15NPv705XVc4iTE6mCwMpmwzTCtZwZ40GdziIoOUZTDnZY0ZtE+gTXpsZwtfaDVA1y/0+GRltPXLynGZytTyPmev+mW64PboWPafSUiieIFcoHWvmg0qotcdHRmwn7sOdO31Laq20ybIr3bBzNR+poyVyu8t3T0k4b39/SEBH/icj0P+DEhYW1wFWitHPPTY+R2Xns3Q50WA/k3Am+h/hb7Qghw/u5hscpIupdhmnhDWz8tUaSIxk8DL52SlMsyUyM52tkTpJZ1TLRYp+zD+dHoYK1jOFnsNu8XFgFvW7pM0UfwyU5EWmlJ6SjYI74R0iYelvtkj0f2XQFW4cTWGWYVxFpiCBCI5NLDXFIkwxKewzmdjbluKUugasW5rS0HcGQvYPPMjbTOBcyy1qVD5rv+EHImGGmO117ku23Q0ashUmzZUE+2WtZPaeV0tTSQw51ZSm3Zdywxm6L/AGQ9DXnATEkBVV9SPuk/6CV1p3f67yeSM9XbaBMibdXs93i3nxrGx0h5Nj0xb9v6MjBCWdSM7qer0g3QbHkXL5jrOYxdNuxbbwDSk5lttK072Pvwxge6FRZUUd6G/GgLoNiHla4szi674XiNkxWl1vnquvfmeN04CUs10JGWNg9qgdTgc8wdLlIFRbn4UiXW+4uHm7Oxvpfia+f729HjvR6bkMgxRIQ2bLv0vgRtJZx0tfYcEUnNLyRKz4RKaZsodXtiybWn5a42WLsCrVUKGOhEyzBAC0hkvHW450w8DsHfeTbT7bEX4upPdIleLkPdlTV+QUGOOL+72ivI1NLZwetwYtqiB4tbwQeUYNY7zHENjflj2atA6zi4oa6bdu73SglQsv6N3Kr+LPuoAOeRvWIu3Qx0Hk2iSEosG90GQ+gTs/hConSw0TZSIDbrtSQkXGfHStv8AXCm+cg== +sidebar_class_name: "put api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Update a theme + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.RequestSchema.json new file mode 100644 index 00000000000..763b0e4917c --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"deleted":{"type":"array","items":{"type":"string"},"description":"List of deleted chart customization IDs."},"modified":{"type":"array","items":{"type":"object"},"description":"List of modified chart customization configurations."},"reordered":{"type":"array","items":{"type":"string"},"description":"List of chart customization IDs in new order."}},"title":"DashboardChartCustomizationsConfigUpdateSchema"},"example":{"deleted":["string"],"modified":[{}],"reordered":["string"]}}},"description":"Chart customizations configuration","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.StatusCodes.json new file mode 100644 index 00000000000..28bc94c6ad6 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"array"}},"type":"object"},"example":{"result":[]}}},"description":"Dashboard chart customizations updated"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.api.mdx new file mode 100644 index 00000000000..3705661a559 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-chart-customizations-configuration-for-a-dashboard.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-chart-customizations-configuration-for-a-dashboard +title: "Update chart customizations configuration for a dashboard." +description: "Update chart customizations configuration for a dashboard." +sidebar_label: "Update chart customizations configuration for a dashboard." +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v2zgM/isEccBanNusux0weNiHrtuw7oatWNN7QV10is3UWm3Jk+S0meH/fqBkO06T4l42oJ8SyyTF5yFFkW6wEkaU5MhYjM8blApjrITLMUIlSuKna4zQ0NdaGsowdqamCG2aUykwbtAtK5aSytEVGWzbiyBN1r3U2ZJFUq0cKcd/RVUVMhVOajX5YrXitQ1bevaFUocRVkZXZJwky28zKsixC4OgMEYsMULpqLSjdeuMVFfYRpiRTY2seD+M8b20DvQcOkuQ5sI4SGvrdCm/ea/g+JXdZ81SZ3Iu/9V2nb/3bteb2rpfqtVcXtXGP4WtDWmTkfkhUO+BCFKBohvwG+1j20bopCvY4ith85kWJjti1aOxpj3yzp5VmXB0GsLWRki3oqxYdxSj896zizGV501IjwHfSqxtNzAcbfpu1/nayEzPnq20siFnnjx+/J8ycD3jDNm6cBtR8GzdDf2IhF7tfBuogd5tobFQe24ztvj0u3wvyVpxRVtS5R+8HxTxpcigO8oxHKuFKGQGq4IBldELmbGzmzBHugHLwcNiOVOidrk28htlMRzWLifluv1hyKEtQMaKAckvD4vkjTYzmWWkYvhL15Bp9chBLhYEFZlSWsuInAaRpmQtuFxaMGR1bVLaBnCwF9A9fVh0H7SDua5VFsM0pz6FKBsgQKbJgtIO6FZycm0iGmx4RE+ePHTmVUZzKMSsIOCsc8sYfufDFLKPjNFmG44jXReZh9pZ6LR5q18fujgcK0dGiQIsmQWZgCKGQwW1otuKUg6aXwSdprW553i9EU4UAwURWkprwxi5G/lyE6roRYROXHGHsiqflm+W271UZ3Tq3QsNTCHUFcaYnn16jxEWYkbF6rE7BDGmtSlg7084OZtCgrlzVTyZFDoVRa6ti589fvZsIio5WRxMsn7DycHEV+zL9YqdICRJogD23kKCh12t8O9ieEnCkIGfDo+OXp+eXk4//vb6w7rCUQjg3nRZUQx3Y7iSzeBRk+A1LROMIcGFKGpKsH2EbTSAPlm63N+JPexhYQAuy0ob1x8rm6hE9fclvBiW96va7fC28P3sRMFOTiIjY180dzgKcDqeEoSfu7p16fQ1qbbTZi5ebMOfqN1EVUYqt9Pj2Gfhnd3dMTPvxEKc+qwbsbO2uEoNrSwTNJAiboR0MCeX5p6TH8NIE4CV5HKdMaKTs+ldsuJeCu5mFpPwuU+uJjA29YR9jlYq49wKtG3mV5DueZ7pbBnDu9OPH/ZDQZDz5U4D17QckQ7tLksz988TFfjKhBMDV3ci0QnpgvYLfbXDorvPkQ/1nZvWtz7b26K1rg/m2oCAgel9jDAQyeNK7ScHHmFi3AxKU123W+PCOeArWagjteEU2Rpp3Oi1+TVktKBCVyUp19VEn4HBUFMZ7XSqizaeTBo21cYNH8V2w1rouHsTES6EkXx12K6MezOh154L32d6NzFCUnXJNbJ75B9fJdftv51OT2Cw00bI3qzbG/BuOHcaij2/4/EQtIHjEzbCWNaNbKWq0/fSrZ8V+4Lvx4kA0pf9Bmc+v99oUwq29+6PKXaDJ5/T8BaH68qDbiNWvjQ0N2Tz/2uErVitPq2m2Nc/ZMKJUKq5DkbWSKkrMpaY7X4IGy1xSga5xUFg2rpS+Ou9m9C/6+CsuTK0A45u3aQqhPRdoc/hpjtU5ygqyX4dsHZvCiOM/ZeCrWfros+yc2yambB0Zoq25eWvNRm+7C9Wie7PXyZ9v5RhPBeFpQ0/h8YHdz513fsurAK57n8/vamlP09FzU8Y8XUSPnC0HJxQdf3u4cW4fo4UNxotPuZB4zBNyV8n98tejGrVyRln46z7TFLqjFWMuOGxVtwEH3UVKOS5ktfCnVaHJiyY5ITlIWUUvyGxuz8MaisLTRMkwu3RDqT465d5adu/AYY3T6Q= +sidebar_class_name: "put api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Update chart customizations configuration for a dashboard. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.RequestSchema.json new file mode 100644 index 00000000000..efc94cd3e8e --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"description":{"description":"Group description","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"label":{"description":"Group label","maxLength":150,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"Group name","maxLength":100,"minLength":1,"type":"string"},"roles":{"description":"Group roles","items":{"type":"integer"},"type":"array"},"users":{"description":"Group users","items":{"type":"integer"},"type":"array"}},"type":"object","title":"GroupPutSchema"},"example":{"description":"string","label":"string","name":"string","roles":[1],"users":[1]}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.StatusCodes.json new file mode 100644 index 00000000000..a87a64e5667 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"description":{"description":"Group description","maxLength":512,"minLength":0,"nullable":true,"type":"string"},"label":{"description":"Group label","maxLength":150,"minLength":0,"nullable":true,"type":"string"},"name":{"description":"Group name","maxLength":100,"minLength":1,"type":"string"},"roles":{"description":"Group roles","items":{"type":"integer"},"type":"array"},"users":{"description":"Group users","items":{"type":"integer"},"type":"array"}},"type":"object","title":"GroupPutSchema"}},"type":"object"},"example":{"result":{"description":"string","label":"string","name":"string","roles":[],"users":[]}}}},"description":"Group updated"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.api.mdx new file mode 100644 index 00000000000..50d34852030 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-groups-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-security-groups-by-pk +title: "Update security groups by pk" +description: "Update security groups by pk" +sidebar_label: "Update security groups by pk" +hide_title: true +hide_table_of_contents: true +api: eJztWG1v2zYQ/ivEYUATTIntYAUKFf2QBu2armuN2tkGRIZLSxdbDUWqJOVEE/TfhyMlWX4JirYD8mH7ZJM8Hvk89/B4VAU51zxDi9pAeF1BKiGEnNsVBCB5htS6hQA0filSjQmEVhcYgIlXmHEIK7BlTlaptLhEDXU989Zo7EuVlGQSK2lRWvrL81ykMbepkoPPRknq2/jKtcpR2xQNtRI0sU5zst1rwq9aFTnr9wWQ8ft3KJd2BeHT0VkAWSrb9jAAWQjBFwJbCM3GjdWpXEIdgOALFA+t5Ae31hg9HX7zGp7Tw0u4se0VhtsrjA541EocoKtx6QcDSC1m5lC0Oodca15SuzBOC4f9+cFv8LfpUIvPGFsIwKaWCPIex4Wd+PDXAeA9z3JxgJ8GbReiTUej0a7dsHE9mnVIrkezmvax7fJ3laBgjfR29U20osmVNJ7as+HwB3Ss0RTC/q/v/7i+90y3Fb9RyY9qvyd9Uv6e9BuoecItJrSLX35I3hkaw5fYY6sN3lcQdxPhJU9Yc2eE7FKuuUgTtrmZWK7VOk1os/toenM9ltHjYrmSvLArpdO/MQnZeWFXKG2zPuvSzAEg/YkeyS+Pi+S9suxGFTIJ2XSFLclIdBtV6BhZotAwqSzD+5To3wfV+XCIzs4eOza5VjE1FwIZxcWWIfuD5Objg1orfQjHhSpE4qA2HprZtNTTxz4+l9Killwwg3qN2qMI2blkhcT7HGMKmutkKo4L/YAAX3PLRUdBAAbjQhNGKgw/31mXT2YBWL6k3AKTZpy5hGJgFgABc7AvEwjBp5h562e+dHbzRTl3NeX9SawSnDhAvvoUXC4hhPjq47tewmuaXnPULrRgJ3+x8dWURbCyNg8HA6FiLlbK2PDZ8NmzAc/TwXo0aJce+KUHowhYFEWSsZM3LILz5sC5LYfsJXKNmv10fnHxajKZTz/89ur99oQLH+OTaZljyHbDvLFN2JMqglssIwhZBGsuCoygfgJ10KEcl3blrvUWZ9fRIU2zXGnbnjwTyUi2dQl70XWf5oU9omXZd9AR+Ikr5Alq86LaIcXvvyEmAvYz4zHJf27VLcq6mU3gXxwCHMnjSOY6lfao3fgpGR8dH/epeMvXfOKU2KNjq3MTfCUNMdKxwO94atkN2njlSPhOCiqPJEO7UglBGF9Nd9kJWyu2qx1C/amVT+UpmjqGPgWbKX31eJ72FeStW2IXKilD9nby4f2pzwrpTXlUsVsseyyz+pisieznkfQEJdzyjpwd6hsjJfBUqOURmR4/BzrZOxeSO76sZYx5xtiiZO74eqrogVhQhNyjMYSHeK7y25ri6DKUP+2FpjAfjBbs7uUdDbME1yhUnqG0Ta5zKvKOqlwrq2Il6nAwqMhVHVZ0fuo9bxeFsSprXQSw5jqlK8E06dm58aXYDXdVmdsmBICyyCj3NU36cYlv2/+b6XTMOj91ALSbbX8d3r3NTXwSpzGq8JjS7HJMTgjLtpODVDXznXXtnuNtLFwl6kG6dF7Bwkn2tdIZJ39v/5xC87ans+ZHobuGHOg6oMlzjTcazep7nZAXo+THzYeCV//e42/Yq4CHszqAVN6ofceTIkdtsF+z97pIpt5uPfLsG5txd5U3637lfOw87xr4Fu/tIBc8le4xop3M/Nm5Bp6ntPIIepdvAN4vBBDmt6Q1L6ZrqKoFN3ilRV1T95cCdenL/1bP7pglqSt3EghvuDC4t7GuboGjj015esw28drecPv6kaU7NqKgFgSU+f2nopr49vnSre4H+pmvN3GvTqLT7GecxzG6zP+w7ayXg8ZXJLpF88EpUwlN0fyOVMHv/B6Vg+yf5NTnr5/C11DeJemSqvBewDr9Nn8I1EEWqspb+Lxfd6S4m5J4qet/AKsSrb4= +sidebar_class_name: "put api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Update security groups by pk + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.ParamsDetails.json new file mode 100644 index 00000000000..5c0c197a9fc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"role_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.RequestSchema.json new file mode 100644 index 00000000000..54259d25f19 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"group_ids":{"description":"List of group ids","items":{"type":"integer"},"type":"array"}},"required":["group_ids"],"type":"object","title":"RoleGroupPutSchema"},"example":{"group_ids":[1]}}},"description":"Update role groups schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.StatusCodes.json new file mode 100644 index 00000000000..37e8c24e9dc --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"group_ids":{"description":"List of group ids","items":{"type":"integer"},"type":"array"}},"required":["group_ids"],"type":"object","title":"RoleGroupPutSchema"}},"type":"object"},"example":{"result":{"group_ids":[]}}}},"description":"Role groups updated"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.api.mdx new file mode 100644 index 00000000000..2bf27e844a7 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-roles-by-role-id-groups.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-security-roles-by-role-id-groups +title: "Update security roles by role_id groups" +description: "Update security roles by role_id groups" +sidebar_label: "Update security roles by role_id groups" +hide_title: true +hide_table_of_contents: true +api: eJzVV21v2zYQ/ivEYUATTImTogMKFf2QBu2armiN2N4GRIZLi2ebrUSqJOXEE/TfhyMlWX4pVqwDgn2ySR2P9zz3ygoKbniODo2F+K4CqSCGgrsVRKB4jhCD0RnOpIAIDH4tpUEBsTMlRmDTFeYc4grcpiBRqRwu0UBdT4M0WvdKiw2JpFo5VI7+8qLIZMqd1Grw2WpFe1tdhdEFGifR0mppdFnMpPALgTY1sqCDEMN7aR3TC+ZFGIlEIB3m9phFUbvDjeEbqOs+nLveNdNOUs8/Y+ogAiddRhu3OsNfSXBYulGwt44AH3he0PcdY+8upzVdsmvypBDcISNKg9mWNcD32fX22UIrG3h4enHxAywatGXm/n/s1vviu3xvYfWZJ+IPmL/tUV56LwhS9uyHaM3RWr7EHiPWGamW/2h4dxBeccGaTInZjVrzTAq2TUpWGL2Wgow9xNQ7G7BcPi6WieKlW2kj/0IRs6vSrVC55n7WxcOxtOgdDEiePS6SD9qxhS6ViNl4hS3JSHRbXZoUmdBomdKO4YMk+g9BdTo8oqdPH9s3hdEpLecZMvKL28Tsdwq34B80RptjOK51mQkPtdHQnKarfnns9LlRDo3iGbNo1mgCiphdKVYqfCgwJaf5TabTtDTfCMA33PGsoyACi2lpCCP1xM/3zlcVql18SRUGRs13RmXFVzXC5VHfCIghVJhZq2ZGBd/O5uHPTIpZqEQQwcNZqgWOPLTQgjOulhBDOrl9DxFkfI7Zdhmij9alydjZn2w4GbMEVs4V8WCQ6ZRnK21d/Pzi+fMBL+RgfTlorRh4KwZVY0M9CEYkwJIkUYydvWUJXDWJ6LHE7BVyg4b9dHV9/Xo0mo0//vb6w+6B6+D7s/GmwJjtu38rK9iTKoEvuEkgZgmseVZiAvUTqKMO83DjVlr1UHcbHW6ZF9q4NiNtohLV9kn2sts+L0p3QteyHyYnCmpWyAUa+7LaoyigaWhKgP3MeEpJMnP6C6q6OU1UvDwGP1GniSqMVO6khXFOwienp31i3vE1H/l47ZGzs7kNDK0s8dNxwu+5dGyBLl15Sv4TQqqAK0e30oIADSfjfa7iVortxxVx8KkNrSoQNvZ8fYq2R/qRFVg7jK4g3dI812ITs3ejjx/OQyWRi81Jxb7gpsc5q09Jmqh/kahAl+COd1TtOaIR0hmeZ3p5QqKnL4CqwdHZruXPD3mWzcOfmRSsy/nAGg3aJbnOj9sxfKcDyNe+1oVqURoKhaMehX0L39NnJnCNmS5yVK6pmj7SgqKqMNrpVGd1PBhUpKqOK8q4+kDbdWmdzlsVEay5kdRcbFPovZowVy64H9O8mRABqjKnKtos6cfX0F39b8fjIev01BGQNbv6OrwHxo1CO6Bv9Ixh2rCbISkhLLtKjlLVnPfStX/OtG7xo2kA6RtDBXMfyG+0yTnpe/fHGJq3EeVj+ApdQ/Og64gOzwwuDNrVv1VCWqxWt9uH1uvjb5GLaR2BVAt9OOaPygKNxf4g3tuiMAty68vAnnU59029eR1+f9Tv3Nt1fIcPblBkXCrS74OwajLiDnghyYhL6HXkyD9ISWG8fZk2l0zbILmDqppzixOT1TVtfy3RUDefbuPUp4+QfiASEC94ZvHAym6ygZPbZoA9ZVs/7FrfvoHUxqdDVtIKIqr6vXd0Tc4IJdKbEL72i13v9ME4RakaTlylKfrS/23Zaa/WDCcUUfPmNZ5r4d/2/J4I5ffBUO1xhxcj7YX+U4ZRK6ikoKNhvefCLjibPwTqKBVVFSRCqa87ZnyrJF7q+m+Q7r84 +sidebar_class_name: "put api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Update security roles by role_id groups + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.ParamsDetails.json new file mode 100644 index 00000000000..fd77b4c69a4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.RequestSchema.json new file mode 100644 index 00000000000..96f502941f8 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.put"},"example":{"id":1}}},"description":"Model schema","required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.StatusCodes.json new file mode 100644 index 00000000000..717b98f5d52 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"id":{"type":"integer"}},"type":"object","title":"UserRegistrationsRestAPI.put"}},"type":"object"},"example":{"result":{"id":1}}}},"description":"Item changed"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unprocessable entity: Validation error"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.api.mdx new file mode 100644 index 00000000000..8a654ff0e03 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-security-user-registrations-by-pk.api.mdx @@ -0,0 +1,68 @@ +--- +id: update-security-user-registrations-by-pk +title: "Update security user registrations by pk" +description: "Update security user registrations by pk" +sidebar_label: "Update security user registrations by pk" +hide_title: true +hide_table_of_contents: true +api: eJzFV21v2zYQ/ivEYUATTImTogMKFf2QBi2arkuN2N4GRIFLi2dbjUSyJOXEE/TfhyMlWX4p9tIN+WSTujve8/DhHVmB5oYX6NBYiG8ryCTEoLlbQgSSF0ije4jA4NcyMyggdqbECGy6xIJDXIFba7LKpMMFGqjru2CN1r1RYk0mqZIOpaO/XOs8S7nLlBx8sUrS3CaWNkqjcRlaGmXiYPyonVKzL5g6iMBlLqeJiUVzg4vMOuNXsDdo3cXw6lSXDuoI8JEXmixD7POaggm0qck02UMMvyiBOWsy2oVd04TVStqQ4POzs++AZ9CWufvfYe85bhOxyaKlZI+TK4cFS5dcLlCQ94vvgl2gtXyBPYzWmUwu/jLTzhHecMEaicXsSq54ngm2ETLTRq0yQcnug+n5BiznT4tlInnplspkf6CI2UXplihdsz7r5HcASN8xIHnxtEiulWNzVUoRs/ESW5KR6LaqNCkyodAyqRzDx4zo3wfVxfCInj9/6r3RRqU0nOXIaF/cOma/ktzC/qAxyhzCcanKXHioTYTGm5b66amPz5V0aCTPmUWzQhNQxOxCslLio8aUNs1PMpWmpfmGAN9xx/OOgggspqUhjNRHvjw4iG/vqBk4vqDe8s0yBXcREEI/eSUghlIL7nDaBpyWFs3U9F2ns/XU96XHk1QJHHmUoYPlXC4ghnRy8xEiyPkM880wCJHGpcnZye9sOBmzBJbO6XgwyFXK86WyLn559vLlgOtssDoftGkM9tMYnCfAkiSRjJ28ZwlcNCfSf43ZG+QGDfvh4vLy7Wg0HX/6+e31tsNlEMHJeK0xZrs62NgK9qxK4B7XCcQsgRXPS0ygfgZ11CEert1SyR7mbqJDnRVaGdceTZvIRLYNjb3upqlvHNGy7DupiUKQJXKBxr6udggKWBqSEmA/Mp7SWZk6dY+ybryJiNeHwCfyOJHaZNIdtSBOyfjo+LhPywe+4iMv2x41W5MbUShpiZ2OEf7AM8fm6NKlJ+Q/oKMKqAp0SyUIznAy3mUqbq3YrqaIgc+trKpA19iz9TnauPRVFTjbV1awbkmeKbGO2YfRp+vTUE6y+fqoYve47jHO6mOyJuJfJTKQJbjjHVE729AYqRxPc7U4ItPjV0AlYaeT+ePOWvYYsce22GOzNfPHPdBGl9KSds5fVGP4O/xX+r6mvfYlL1SK0pAUDu4o7Ob4kT4zgSvMlS5QuqZ4eqWFQJU2yqlU5XU8GFQUqo4rOm/1XrTL0jpVtCEiWHGTUY+xTb33Yei/wDn31zOfJkSAsiyomDZD+rGwx+j78XjIujh1BJTNdrwO715yo9AV6Bu9AJgy7GpIQQjLdpCDVDX+3rr2z4F2X0bU0wJI3x8qmHkpv1Om4BTvw29jaN4WdB7DV+j6mgddR+Q8NTg3aJf/NghFsUrebB4qb7cfB2d1BJmcqwB4C1+p0Vjs38B7U6SuYLc6D6RZV3Df0pv31D+Q+9bCXcN3+OgGOueZpAW8+KrmKNwC1xllcQ69hhzB/oGACGJ9T9IJ2riFqppxixOT1zVNfy3RUC+/28jTnxqR+euQgHjOc4t7SXb3Gji6aa6vx2xD/3byzSSXa38K8pJGEFGxDy/P+o7U68uiXz186Be4nuPePYoOZ/C4SFP0xf7btne98jKckIZmzfu1UIJcDH+gJyF/CDkqHYikRxTNhY5ThjtWCEkyo1t6b/M6OTZ/CNRBFqoqWITyXnek+OZIvNT1n9amdAc= +sidebar_class_name: "put api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Update security user registrations by pk + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.RequestSchema.json new file mode 100644 index 00000000000..26c4519543d --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"first_name":{"description":"The current user's first name","maxLength":64,"minLength":1,"type":"string"},"last_name":{"description":"The current user's last name","maxLength":64,"minLength":1,"type":"string"},"password":{"description":"The current user's password for authentication","type":"string"}},"type":"object","title":"CurrentUserPutSchema"},"example":{"first_name":"string","last_name":"string","password":"string"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.StatusCodes.json new file mode 100644 index 00000000000..ce84b5655b4 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"integer"},"is_active":{"type":"boolean"},"is_anonymous":{"type":"boolean"},"last_name":{"type":"string"},"login_count":{"type":"integer"},"username":{"type":"string"}},"type":"object","title":"UserResponseSchema"}},"type":"object"},"example":{"result":{"email":"string","first_name":"string","id":1,"is_active":true,"is_anonymous":true,"last_name":"string","login_count":1,"username":"string"}}}},"description":"User updated successfully"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.api.mdx new file mode 100644 index 00000000000..0139af64327 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/update-the-current-user.api.mdx @@ -0,0 +1,66 @@ +--- +id: update-the-current-user +title: "Update the current user" +description: "Updates the current user's first name, last name, or password." +sidebar_label: "Update the current user" +hide_title: true +hide_table_of_contents: true +api: eJzFV1Fv2zYQ/ivEYUATTInroRgKFX1Igg5tV7RGbWMDoiClpbPNRiJVknKiCfrvw5GSLFlukS0D9iTpdHe877vj8VhBgibWIrdCSQhhmSfcomF2iywutEZpWWFQPzNsLbSxTPIMA5by7lVplnNj7pVOziEAjd8KNPZSJSWEFcRKWpSWXnmepyLmtNDkq6HVKjDxFjNOb7lWOWor0NCXW+uWFqCvYYiLH4UGAWT84QPKjd1C+OuLADIh289pALbMEUIwVgu5gToAQvL4hTrc/3idlqNHLdMqs7XSjBd2i9I21MHId91J1OorxpY0hE1JcOXdLg3qWWHnnuw6AHzgWZ7iIdOtywEre+Eewn7t2mdcaEwgtLpAJzC5ksZn8pfnz59QBxpNkdqxHDMuUnoZ8TysnNFvkfTEQlrcoHZyc8tjK3Z9q5VSKXLZ/pZKlpkqzHGNQR2Nq0xthLyNVeEpGK9Pif+O9Q/yS4n93LDdZnekPsz3ntGGw31+j5cCMTYdEERpPqTEy46WzQD7tA+1V0Z1cNiIDGpWuG6UMFPEMRqzLtK0JDwvnlRUGRrDN4+ieshdZwiXPGFNpwvZO7njqUhYzjXP0KI2LNdqJxJM4Aiynq3HMv1/sSwldRilxV+YhOxi0G1Yt7mPpahn6NYzGBda2BLC6wq+3lsIr2/qmwAs3xgIr9t2xCi3cBPAw1msEpy7mIwzSrncQAjx8vMH14VWmO4/jSp0TBHHhU7Z2Z9stlywCLbW5uFkkqqYp1tlbPjy+cuXE56LyW46yXASAYuiSDJ29pZFcNGE7OCF7BK5Rs1+uri6ejOf3y4+/f7m49DgyifmbFHmGLLD3Ox1E/asiuAOywhCFsGOpwVGUD+DOuhwzUq7dS28RdYJOmwiy5W2bYGYSEay7afsdSc+zwt7QsuyRxEQeNUt8gS1eV0d0OAjbqiIgP3MuNtvt1bdoawba4L7+hjESJ5GMtdC2pM21HNSPjk97YN/z3d87sqnR8BAuE+wkoY46HDzey4sW6ONtw72o0FXPvYM7VYlFPRsuTjkI2y12GF9EM4vbYlUnpSF4+RLsDfpV4hnZlwlXrulcqWSMmTv558+nvvtKtblScXusOzxyupT0iZ6X0XSU5Jwyzs6DshulFSK56nanJDq6Sug/efRQwh5Yd05TkMK9Mgi7lHvUPtdWGhKzVGG4bAJfKDfLMEdpirPaHd7Ty7z3lGVa2VVrNI6nEwqclWHFVV5PfJ2VRirstZFADuuBV+lvte1bvwItebuHHNhQgAoi4x6TPNJD0M9Zuj/7WIxY52fOgCKZuivwzsKbu6iYvSPzi+afN/N3Gyn9IGTo1Q19k67rikxbcN0Z7cH6dpmBStXdL8pnXHy9/6PBeXIqdHc4f7uR0EHug7I+FbjWqPZ/lsn5MUo+Xk/xr/5r4bFAIRcq/EAPC9y1Ab7g01PRFXp9XZTT7axGXeHYrOmv7OMriyH/PfO2KdfcxrOLD7YSZ5y4WZAV+5Vs7+ugeeC4p/SXYEuDFSOvt6uoapW3OBSp3VN4m8Fajo2b/Yl7w7PAHyPctvyDkvaIr1u43ZIWlAko6GB9p+3uIhjdP31+7r9JjFbUpmsmgtcphIy0fyeLnf8HkKAAJTj1I/oJPNNvvADhXdJlUTzQX9cbiuueSFQzS8uy16AVeU1fK+lNuGRuPMI6pu6rv8G5r8OqQ== +sidebar_class_name: "put api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Updates the current user's first name, last name, or password. + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/user-registrations-rest-api.tag.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/user-registrations-rest-api.tag.mdx new file mode 100644 index 00000000000..a06d35cf3e0 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/user-registrations-rest-api.tag.mdx @@ -0,0 +1,19 @@ +--- +id: user-registrations-rest-api +title: "UserRegistrationsRestAPI" +description: "UserRegistrationsRestAPI" +custom_edit_url: null +--- + +Endpoints related to UserRegistrationsRestAPI. + +| Method | Endpoint | Path | +|--------|----------|------| +| `GET` | [Get security user registrations](./get-security-user-registrations) | `/api/v1/security/user_registrations/` | +| `POST` | [Create security user registrations](./create-security-user-registrations) | `/api/v1/security/user_registrations/` | +| `GET` | [Get security user registrations info](./get-security-user-registrations-info) | `/api/v1/security/user_registrations/_info` | +| `DELETE` | [Delete security user registrations by pk](./delete-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` | +| `GET` | [Get security user registrations by pk](./get-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` | +| `PUT` | [Update security user registrations by pk](./update-security-user-registrations-by-pk) | `/api/v1/security/user_registrations/{pk}` | +| `GET` | [Get distinct values from field data (security-user-registrations-distinct-column-name)](./get-distinct-values-from-field-data-security-user-registrations-distinct-column-name) | `/api/v1/security/user_registrations/distinct/{column_name}` | +| `GET` | [Get related fields data (security-user-registrations-related-column-name)](./get-related-fields-data-security-user-registrations-related-column-name) | `/api/v1/security/user_registrations/related/{column_name}` | diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.ParamsDetails.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.ParamsDetails.json new file mode 100644 index 00000000000..e4cca44326a --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.ParamsDetails.json @@ -0,0 +1 @@ +{"parameters":[{"description":"The type of datasource","in":"path","name":"datasource_type","required":true,"schema":{"type":"string"}},{"description":"The id of the datasource","in":"path","name":"datasource_id","required":true,"schema":{"type":"integer"}}]} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.RequestSchema.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.RequestSchema.json new file mode 100644 index 00000000000..c5f4f1013aa --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.RequestSchema.json @@ -0,0 +1 @@ +{"title":"Body","body":{"content":{"application/json":{"schema":{"properties":{"clause":{"description":"SQL clause type for filter expressions","enum":["WHERE","HAVING"],"type":"string"},"expression":{"description":"The SQL expression to validate","type":"string"},"expression_type":{"default":"where","description":"The type of SQL expression","enum":["column","metric","where","having"],"type":"string"}},"required":["expression"],"type":"object"},"example":{"clause":"WHERE","expression":"string","expression_type":"column"}}},"required":true}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.StatusCodes.json b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.StatusCodes.json new file mode 100644 index 00000000000..9f8f0258821 --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.StatusCodes.json @@ -0,0 +1 @@ +{"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"Empty array for success, errors for failure","items":{"properties":{"end_column":{"type":"integer"},"line_number":{"type":"integer"},"message":{"type":"string"},"start_column":{"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"example":{"result":[{"end_column":1,"line_number":1,"message":"string","start_column":1}]}}},"description":"Validation result"},"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Bad request: Invalid parameters provided"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Unauthorized: Authentication required"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Forbidden: You don't have permission to access this resource"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Not found: The requested resource does not exist"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"},"example":{"message":"Internal server error: An unexpected error occurred"}}},"description":"Fatal error"}}} diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.api.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.api.mdx new file mode 100644 index 00000000000..e0a88f880ec --- /dev/null +++ b/docs/developer_docs_versioned_docs/version-6.1.0/api/validate-a-sql-expression-against-a-datasource.api.mdx @@ -0,0 +1,68 @@ +--- +id: validate-a-sql-expression-against-a-datasource +title: "Validate a SQL expression against a datasource" +description: "Validate a SQL expression against a datasource" +sidebar_label: "Validate a SQL expression against a datasource" +hide_title: true +hide_table_of_contents: true +api: eJzFWG1v3DYM/isCMaAJ5uSarQMKF/2QZunSrkiz3LXdEAeZzubFam3JleRLbob/+0DJb3fndOsLmk+5yBSp5yEpkqqg4JrnaFEbCC8qSNDEWhRWKAkhzFJkdlUgUwuWcMuNKnWMEICgrwW3KQQgeY4QQv/9irZAABo/lkJjAqHVJQZg4hRzDmEFTiAEY7WQ11DXwZhhkZBZm+LnmBbJ/zEspMVr1FDXl14ajX2mkhWJxEpalJZ+8qLIRMzpTJP3hg5WDXQVWhWorUDjtmW8NEi/1pFM/3jF/DfP5EJpthCZRc3wttBojFDSQAAoyxzCC3h3cnx+DAGcHL59cfobXAabbAXQb9y2R8yRzV6GWcWWPBMJt8TfJ7R5xzmVC15mFkK4SVHTrrvjYt3YAEissjKnhRytFjEEnbKUL8n2NrR66LuLIc5eVs3fY2z9wXleZDhkv2NvSFGrfgRqe8h63TSFjVswhZLGO/inhw+/Ijw0GkfopruO88KuGNear1xomDKO0ZiAodZKGx8uXGSlI05YzM22cpTJVQNkJMYDyITEK1nmc9TjAjkaw69xJDUDMJZr+wn19YhnmgUHa1xi4LuWmot1IAcb5z4YHLP36PrpDupL58l1jt/64KdUaGzVATz6KnfeTdh/gO0hPOMJa66ekL2QLkNZfxuzQqulSDCBEUSDvR7Lwf1ieSN5aVOlxT+YhOywtClK29hnXVqNABlu9Eh+vl8kz5WeiyRBGbK/VMkSJR9YlvIlsgJ1LroLlbs0ZTYVhoLKF6cRgJ0+j+7R/aI7VZYtVCmTkNEV3oQQJh0Elig0TCrL8FZQcG0j6nSQlV/uO4teSIta8owZ1EuqqXRthuxQslLibYExoXOLTMVxqe+Iw+fc8szLOeMG41ILu3K30vsbup0uqVew/Jr6JPi16zgMlabbvVglOHXn831UxuU1lZc3568ggIzPMev/bcIlhLjUGdv7k529ns5YBKm1RTiZZCrmWaqMDR8/fPx4wgsxWR5M+iZnUm30WvXaikjqSVvvr/qKN4mARVEkGds7YREcNnnnPBWyZ8g1avbD4dHR8XR6NXv9+/Hp+oYj7+O92arAkG26uZdN2IMqgg+4iiBkESx5VmIE9QOgLq+h5WxlU9crtMR0Cx01Ii+Utm2ImkhGsi3H7Gm3vF8oY3fILvsO/AXeUIo8QW2eVhssesANkxGwH5tb4sqqDyjrZjex9XSMoUjuRrLQQtqdFuk+Ce/s7g65e8mXfOpCd8Df2mIfXkoaorCjjd9wYdkCbZw60r4TZZVHnqNNVUKQKd436QxbMbYZnUTT322AVp7TmaP076DfMoxPT+x2jHrp1hNzlaxC9nL6+nTf3ztisdqp2AdcDdzC6l2SJu88iaRnlJB3bG74qhFSGe5n6nqHRHefAN0do00JMr7ZrvNrLsgKX597PHs0+yhDXnYjUAjfzFcUOO4O9RdYqSmuRsNjaxx4RZ9ZgkvMVJGjtM1t7MLWK6oKrayKVVaHk0lFquqwogyvt7QdlcaqvFURwJJrwecZto2vU7M+pdAxB5NH8y/9cdfzuv6T2eyMdXrqAOg06/o6vFuHm/oyQ99o+GRKsxdnpISwrCsZparZ76RrN362pWZKRdKDdAWngrkL+edK55z0vXw3g2aWpeT2X/uBzoGuA9p8pXGh0aRfqoS0GCXP+8H4+BuMWn76q2mCX6iRQbksUBskyq2wZGu4RHHp5ZYHnm5jc+66i+YR4LMTas1814FYvLWTIuPCdWwueKsm1y6AF4LOckC7h6rC7cePcPNRYiTnIAAKTx9/F1BVc27wjc7qmpY/lqipAbnsU8A/0QhDvxMIFzwzuAWka8Zg57xpvXfZnS85o7Db+U2u/MFL+g8CqlkjLz3u+eZLD3XHK8/XHUskUF9SZrvS4ljzMsMiMdCx1bQSJL/jMI7RVdW7ZS8HlzNVNghg3jwm5SqhPZrf0LMUv/HnVY4W/y5Aa762l76j9TopB2k0GkRml6vND0I1ykhVeQlfI+uOINeGgBuR/wX1iPLN +sidebar_class_name: "post api-method" +info_path: developer-docs/api/superset +custom_edit_url: null +hide_send_button: true +show_extensions: true +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; +import Translate from "@docusaurus/Translate"; + + + + + + + + + + +Validate a SQL expression against a datasource + + + Request + + + + + + + + + + + + + diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/dropdowncontainer.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/dropdowncontainer.mdx index 1d6b5e20772..d6e88517ab8 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/dropdowncontainer.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/dropdowncontainer.mdx @@ -22,7 +22,7 @@ sidebar_label: DropdownContainer under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # DropdownContainer diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/flex.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/flex.mdx index b74f06c7f4e..996f054a61a 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/flex.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/flex.mdx @@ -22,7 +22,7 @@ sidebar_label: Flex under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Flex diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/grid.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/grid.mdx index a7fea3d3dc1..16f13d42ee0 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/grid.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/grid.mdx @@ -22,7 +22,7 @@ sidebar_label: Grid under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Grid diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/layout.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/layout.mdx index 1b0d76e0ad1..bda28ca5dc1 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/layout.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/layout.mdx @@ -22,7 +22,7 @@ sidebar_label: Layout under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Layout diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/metadatabar.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/metadatabar.mdx index 2f667cfae4e..847f3cff2e0 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/metadatabar.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/metadatabar.mdx @@ -22,7 +22,7 @@ sidebar_label: MetadataBar under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # MetadataBar diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/space.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/space.mdx index 264667a9fb0..44af004f961 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/space.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/space.mdx @@ -22,7 +22,7 @@ sidebar_label: Space under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Space diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/table.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/table.mdx index db0be495173..18f0ecd0041 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/table.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/design-system/table.mdx @@ -22,7 +22,7 @@ sidebar_label: Table under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Table diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/extension/alert.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/extension/alert.mdx index 45a42c100d0..8c9c32f37d6 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/extension/alert.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/extension/alert.mdx @@ -22,7 +22,7 @@ sidebar_label: Alert under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Alert @@ -108,12 +108,12 @@ function Demo() { ## Import ```tsx -import { Alert } from 'packages/superset-core/src/ui/components/Alert'; +import { Alert } from 'packages/superset-core/src/components/Alert'; ``` --- :::tip[Improve this page] This documentation is auto-generated from the component's Storybook story. -Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-core/src/ui/components/Alert/Alert.stories.tsx). +Help improve it by [editing the story file](https://github.com/apache/superset/edit/master/superset-frontend/packages/superset-core/src/components/Alert/Alert.stories.tsx). ::: diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/autocomplete.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/autocomplete.mdx index 789883dbb4c..2ffde8f0526 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/autocomplete.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/autocomplete.mdx @@ -22,7 +22,7 @@ sidebar_label: AutoComplete under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # AutoComplete diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/avatar.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/avatar.mdx index b2b7458cd4b..579f9922f14 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/avatar.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/avatar.mdx @@ -22,7 +22,7 @@ sidebar_label: Avatar under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Avatar diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/badge.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/badge.mdx index 69531a428b1..d381fbdf614 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/badge.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/badge.mdx @@ -22,7 +22,7 @@ sidebar_label: Badge under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Badge diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/breadcrumb.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/breadcrumb.mdx index 5591b2e089f..3d9fcfcb022 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/breadcrumb.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/breadcrumb.mdx @@ -22,7 +22,7 @@ sidebar_label: Breadcrumb under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Breadcrumb diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/button.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/button.mdx index 0b704f4b666..b3d7afa3db5 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/button.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/button.mdx @@ -22,7 +22,7 @@ sidebar_label: Button under the License. --> -import { StoryWithControls, ComponentGallery } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls, ComponentGallery } from '../../../../src/components/StorybookWrapper'; # Button diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/buttongroup.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/buttongroup.mdx index 233993c4d19..4064536f3b6 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/buttongroup.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/buttongroup.mdx @@ -22,7 +22,7 @@ sidebar_label: ButtonGroup under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # ButtonGroup diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/cachedlabel.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/cachedlabel.mdx index 7f115914456..56a9a0fcd95 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/cachedlabel.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/cachedlabel.mdx @@ -22,7 +22,7 @@ sidebar_label: CachedLabel under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # CachedLabel diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/card.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/card.mdx index 50bf93dbf6e..b324d8c6342 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/card.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/card.mdx @@ -22,7 +22,7 @@ sidebar_label: Card under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Card diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/checkbox.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/checkbox.mdx index 13709c36130..ba79181b173 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/checkbox.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/checkbox.mdx @@ -22,7 +22,7 @@ sidebar_label: Checkbox under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Checkbox diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/collapse.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/collapse.mdx index 4e35c7b4353..297abaf7827 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/collapse.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/collapse.mdx @@ -22,7 +22,7 @@ sidebar_label: Collapse under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Collapse diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/datepicker.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/datepicker.mdx index 4fc45cb6ecb..db7d3455460 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/datepicker.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/datepicker.mdx @@ -22,7 +22,7 @@ sidebar_label: DatePicker under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # DatePicker diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/divider.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/divider.mdx index 0ea8c54bb6e..1374885a02b 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/divider.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/divider.mdx @@ -22,7 +22,7 @@ sidebar_label: Divider under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Divider diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/editabletitle.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/editabletitle.mdx index bea676b0401..b64661df40e 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/editabletitle.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/editabletitle.mdx @@ -22,7 +22,7 @@ sidebar_label: EditableTitle under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # EditableTitle diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/emptystate.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/emptystate.mdx index b0e8171c16d..56fb8fc9c1b 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/emptystate.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/emptystate.mdx @@ -22,7 +22,7 @@ sidebar_label: EmptyState under the License. --> -import { StoryWithControls, ComponentGallery } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls, ComponentGallery } from '../../../../src/components/StorybookWrapper'; # EmptyState diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/favestar.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/favestar.mdx index adb610620d8..2943c6c5f62 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/favestar.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/favestar.mdx @@ -22,7 +22,7 @@ sidebar_label: FaveStar under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # FaveStar diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/iconbutton.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/iconbutton.mdx index 5cfc6e90f55..6bd7d859868 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/iconbutton.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/iconbutton.mdx @@ -22,7 +22,7 @@ sidebar_label: IconButton under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # IconButton diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icons.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icons.mdx index ac90f06c7e7..5a7dd9605bf 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icons.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icons.mdx @@ -22,7 +22,7 @@ sidebar_label: Icons under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Icons diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icontooltip.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icontooltip.mdx index 4d1fdde8699..eb9851dfd93 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icontooltip.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/icontooltip.mdx @@ -22,7 +22,7 @@ sidebar_label: IconTooltip under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # IconTooltip diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/infotooltip.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/infotooltip.mdx index 42e6341ea90..c1304b25b7d 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/infotooltip.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/infotooltip.mdx @@ -22,7 +22,7 @@ sidebar_label: InfoTooltip under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # InfoTooltip diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/input.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/input.mdx index 2bc8706fe63..731f4148dec 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/input.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/input.mdx @@ -22,7 +22,7 @@ sidebar_label: Input under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Input diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/label.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/label.mdx index 816d449770f..3316de122e9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/label.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/label.mdx @@ -22,7 +22,7 @@ sidebar_label: Label under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Label diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/list.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/list.mdx index 06a3b028965..813450dcc46 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/list.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/list.mdx @@ -22,7 +22,7 @@ sidebar_label: List under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # List diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/listviewcard.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/listviewcard.mdx index 63af1c14f34..17312e3bf0f 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/listviewcard.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/listviewcard.mdx @@ -22,7 +22,7 @@ sidebar_label: ListViewCard under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # ListViewCard diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/loading.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/loading.mdx index 0326c19e90a..0eb7cc4c4f1 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/loading.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/loading.mdx @@ -22,7 +22,7 @@ sidebar_label: Loading under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Loading diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/menu.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/menu.mdx index c088eb538c7..b7e909d137e 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/menu.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/menu.mdx @@ -22,7 +22,7 @@ sidebar_label: Menu under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Menu diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modal.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modal.mdx index d1ed9b48234..7e33d443dcd 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modal.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modal.mdx @@ -22,7 +22,7 @@ sidebar_label: Modal under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Modal diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modaltrigger.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modaltrigger.mdx index b9f5bd81b7d..bf8ffe869f6 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modaltrigger.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/modaltrigger.mdx @@ -22,7 +22,7 @@ sidebar_label: ModalTrigger under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # ModalTrigger diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/popover.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/popover.mdx index 0a3ad4b2d10..4b37a011f1e 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/popover.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/popover.mdx @@ -22,7 +22,7 @@ sidebar_label: Popover under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Popover diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/progressbar.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/progressbar.mdx index 4b68653ee11..2b1ee6b299a 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/progressbar.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/progressbar.mdx @@ -22,7 +22,7 @@ sidebar_label: ProgressBar under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # ProgressBar diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/radio.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/radio.mdx index 69cdfcf2c06..cfc8643592c 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/radio.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/radio.mdx @@ -22,7 +22,7 @@ sidebar_label: Radio under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Radio diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/safemarkdown.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/safemarkdown.mdx index 8cb741b962c..3157466e7f8 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/safemarkdown.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/safemarkdown.mdx @@ -22,7 +22,7 @@ sidebar_label: SafeMarkdown under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # SafeMarkdown diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/select.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/select.mdx index 262196d4ccc..4aa9efae083 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/select.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/select.mdx @@ -22,7 +22,7 @@ sidebar_label: Select under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Select diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/skeleton.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/skeleton.mdx index c4c0190babe..a1437807dee 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/skeleton.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/skeleton.mdx @@ -22,7 +22,7 @@ sidebar_label: Skeleton under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Skeleton diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/slider.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/slider.mdx index 3edeeda4aa2..36126afc6f5 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/slider.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/slider.mdx @@ -22,7 +22,7 @@ sidebar_label: Slider under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Slider diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/steps.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/steps.mdx index 7d905a54131..07df1e601f9 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/steps.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/steps.mdx @@ -22,7 +22,7 @@ sidebar_label: Steps under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Steps diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/switch.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/switch.mdx index e0408c9b9d8..ecdffbce753 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/switch.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/switch.mdx @@ -22,7 +22,7 @@ sidebar_label: Switch under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Switch diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tablecollection.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tablecollection.mdx index 049a9cebeca..d86373d8458 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tablecollection.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tablecollection.mdx @@ -22,7 +22,7 @@ sidebar_label: TableCollection under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # TableCollection diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tableview.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tableview.mdx index b560e0b0249..c83cbd66191 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tableview.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tableview.mdx @@ -22,7 +22,7 @@ sidebar_label: TableView under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # TableView diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tabs.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tabs.mdx index 895aa63282b..a1aad6336ee 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tabs.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tabs.mdx @@ -22,7 +22,7 @@ sidebar_label: Tabs under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Tabs diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/timer.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/timer.mdx index 2562205e872..3fcc13fb02a 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/timer.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/timer.mdx @@ -22,7 +22,7 @@ sidebar_label: Timer under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Timer diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tooltip.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tooltip.mdx index 72620d7c0cf..a04a20a9464 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tooltip.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tooltip.mdx @@ -22,7 +22,7 @@ sidebar_label: Tooltip under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Tooltip diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tree.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tree.mdx index 70bfbb173bd..9920238ae34 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tree.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/tree.mdx @@ -22,7 +22,7 @@ sidebar_label: Tree under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Tree diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/treeselect.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/treeselect.mdx index 9bdb8b61a2f..613e4cbd24c 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/treeselect.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/treeselect.mdx @@ -22,7 +22,7 @@ sidebar_label: TreeSelect under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # TreeSelect diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/typography.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/typography.mdx index 5b441405972..3b645dbf6e4 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/typography.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/typography.mdx @@ -22,7 +22,7 @@ sidebar_label: Typography under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Typography diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/unsavedchangesmodal.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/unsavedchangesmodal.mdx index 5a4ba17618f..493c20b310e 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/unsavedchangesmodal.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/unsavedchangesmodal.mdx @@ -22,7 +22,7 @@ sidebar_label: UnsavedChangesModal under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # UnsavedChangesModal diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/upload.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/upload.mdx index 2499f342c6c..1f4e72e0466 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/upload.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/components/ui/upload.mdx @@ -22,7 +22,7 @@ sidebar_label: Upload under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; # Upload diff --git a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/components/alert.mdx b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/components/alert.mdx index 8c42c821160..335032ea82b 100644 --- a/docs/developer_docs_versioned_docs/version-6.1.0/extensions/components/alert.mdx +++ b/docs/developer_docs_versioned_docs/version-6.1.0/extensions/components/alert.mdx @@ -22,7 +22,7 @@ sidebar_label: Alert under the License. --> -import { StoryWithControls } from '../../../src/components/StorybookWrapper'; +import { StoryWithControls } from '../../../../src/components/StorybookWrapper'; import { Alert } from '@apache-superset/core/components'; # Alert diff --git a/docs/scripts/manage-versions.mjs b/docs/scripts/manage-versions.mjs index 060dbe6ef93..6a23d6a06a0 100644 --- a/docs/scripts/manage-versions.mjs +++ b/docs/scripts/manage-versions.mjs @@ -58,16 +58,34 @@ function fixVersionedImports(section, version) { console.log(` Fixing relative imports in ${versionedDocsDir}...`); - function walk(dir) { + // Imports whose `../` count exceeds the file's depth within the section + // escape the section root, so they need one extra `../` once the file + // lives one level deeper inside the snapshot dir. Imports that stay + // inside the section are unaffected (the section copies wholesale). + function walk(dir, depth) { for (const entry of fs.readdirSync(dir, { withFileTypes: true })) { const fullPath = path.join(dir, entry.name); if (entry.isDirectory()) { - walk(fullPath); + walk(fullPath, depth + 1); } else if (entry.isFile() && /\.(md|mdx)$/.test(entry.name)) { const original = fs.readFileSync(fullPath, 'utf8'); - const updated = original - .replace(/from ['"]\.\.\/\.\.\/src\//g, "from '../../../src/") - .replace(/from ['"]\.\.\/\.\.\/data\//g, "from '../../../data/"); + // Track fenced code blocks so we don't rewrite import samples inside + // ```ts / ```js (etc.) blocks that are documentation, not real imports. + let inFence = false; + const updated = original.split('\n').map(line => { + if (/^\s*(```|~~~)/.test(line)) { + inFence = !inFence; + return line; + } + if (inFence) return line; + return line.replace( + /(from\s+['"])((?:\.\.\/)+)/g, + (match, prefix, dots) => { + const upCount = dots.match(/\.\.\//g).length; + return upCount > depth ? `${prefix}../${dots}` : match; + }, + ); + }).join('\n'); if (updated !== original) { fs.writeFileSync(fullPath, updated); const rel = path.relative(versionedDocsPath, fullPath); @@ -77,7 +95,7 @@ function fixVersionedImports(section, version) { } } - walk(versionedDocsPath); + walk(versionedDocsPath, 0); } function addVersion(section, version) { diff --git a/docs/versioned_docs/version-6.1.0/databases/index.mdx b/docs/versioned_docs/version-6.1.0/databases/index.mdx index 26b1d64af1f..b8543911e8f 100644 --- a/docs/versioned_docs/version-6.1.0/databases/index.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/index.mdx @@ -40,7 +40,7 @@ installation documentations ([Docker Compose](/admin-docs/installation/docker-co ## Supported Databases -Superset supports **80 databases** with varying levels of feature support. +Superset supports **73 databases** with varying levels of feature support. Click on any database name to see detailed documentation including connection strings, authentication methods, and configuration options. @@ -91,3 +91,14 @@ To add or update database documentation, add a `metadata` attribute to your engi See [METADATA_STATUS.md](https://github.com/apache/superset/blob/master/superset/db_engine_specs/METADATA_STATUS.md) for the current status of database documentation and the [README](https://github.com/apache/superset/blob/master/superset/db_engine_specs/README.md) for the metadata schema. + +:::info Developer Note +This documentation was built without Flask context, so feature diagnostics (scores, time grain support, etc.) +may not reflect actual database capabilities. For full diagnostics, build docs locally with: + +```bash +cd docs && npm run gen-db-docs +``` + +This requires a working Superset development environment. +::: diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/amazon-athena.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/amazon-athena.mdx index f35c2b9f003..62cb7025779 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/amazon-athena.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/amazon-athena.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.athena","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":false,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":30,"max_score":201,"documentation":{"description":"Amazon Athena is an interactive query service for analyzing data in S3 using SQL.","logo":"amazon-athena.jpg","homepage_url":"https://aws.amazon.com/athena/","categories":["Cloud - AWS","Query Engines","Proprietary"],"pypi_packages":["pyathena[pandas]"],"connection_string":"awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}","drivers":[{"name":"PyAthena (REST)","pypi_package":"pyathena[pandas]","connection_string":"awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}","is_recommended":true,"notes":"No Java required. URL-encode special characters (e.g., s3:// -> s3%3A//)."},{"name":"PyAthenaJDBC","pypi_package":"PyAthenaJDBC","connection_string":"awsathena+jdbc://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}","is_recommended":false,"notes":"Requires Amazon Athena JDBC driver."}],"engine_parameters":[{"name":"IAM Role Assumption","description":"Assume a specific IAM role for queries","json":{"connect_args":{"role_arn":""}}}],"notes":"URL-encode special characters in s3_staging_dir (e.g., s3:// becomes s3%3A//).","category":"Cloud - AWS","custom_errors":[{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"awsathena","engine_name":"Amazon Athena","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"amazon_athena","engine_name":"Amazon Athena","module":"athena","documentation":{"description":"Amazon Athena is an interactive query service for analyzing data in S3 using SQL.","logo":"amazon-athena.jpg","homepage_url":"https://aws.amazon.com/athena/","categories":["CLOUD_AWS","QUERY_ENGINES","PROPRIETARY"],"pypi_packages":["pyathena[pandas]"],"connection_string":"awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}","drivers":[{"name":"PyAthena (REST)","pypi_package":"pyathena[pandas]","connection_string":"awsathena+rest://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}","is_recommended":true,"notes":"No Java required. URL-encode special characters (e.g., s3:// -> s3%3A//)."},{"name":"PyAthenaJDBC","pypi_package":"PyAthenaJDBC","connection_string":"awsathena+jdbc://{aws_access_key_id}:{aws_secret_access_key}@athena.{region_name}.amazonaws.com/{schema_name}?s3_staging_dir={s3_staging_dir}","is_recommended":false,"notes":"Requires Amazon Athena JDBC driver."}],"engine_parameters":[{"name":"IAM Role Assumption","description":"Assume a specific IAM role for queries","json":{"connect_args":{"role_arn":""}}}],"notes":"URL-encode special characters in s3_staging_dir (e.g., s3:// becomes s3%3A//).","custom_errors":[{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/amazon-dynamodb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/amazon-dynamodb.mdx index 8801bdfdedb..3b0e55ce7b9 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/amazon-dynamodb.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/amazon-dynamodb.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.dynamodb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":32,"max_score":201,"documentation":{"description":"Amazon DynamoDB is a serverless NoSQL database with SQL via PartiQL.","logo":"aws.png","homepage_url":"https://aws.amazon.com/dynamodb/","categories":["Cloud - AWS","Search & NoSQL","Proprietary"],"pypi_packages":["pydynamodb"],"connection_string":"dynamodb://{aws_access_key_id}:{aws_secret_access_key}@dynamodb.{region}.amazonaws.com:443?connector=superset","parameters":{"aws_access_key_id":"AWS access key ID","aws_secret_access_key":"AWS secret access key","region":"AWS region (e.g., us-east-1)"},"notes":"Uses PartiQL for SQL queries. Requires connector=superset parameter.","docs_url":"https://github.com/passren/PyDynamoDB","category":"Cloud - AWS"},"engine":"dynamodb","engine_name":"Amazon DynamoDB","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"amazon_dynamodb","engine_name":"Amazon DynamoDB","module":"dynamodb","documentation":{"description":"Amazon DynamoDB is a serverless NoSQL database with SQL via PartiQL.","logo":"aws.png","homepage_url":"https://aws.amazon.com/dynamodb/","categories":["CLOUD_AWS","SEARCH_NOSQL","PROPRIETARY"],"pypi_packages":["pydynamodb"],"connection_string":"dynamodb://{aws_access_key_id}:{aws_secret_access_key}@dynamodb.{region}.amazonaws.com:443?connector=superset","parameters":{"aws_access_key_id":"AWS access key ID","aws_secret_access_key":"AWS secret access key","region":"AWS region (e.g., us-east-1)"},"notes":"Uses PartiQL for SQL queries. Requires connector=superset parameter.","docs_url":"https://github.com/passren/PyDynamoDB"},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/amazon-redshift.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/amazon-redshift.mdx index fc8e603dcd7..06e16fdb2ea 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/amazon-redshift.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/amazon-redshift.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.redshift","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":127,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":44,"max_score":201,"documentation":{"description":"Amazon Redshift is a fully managed data warehouse service.","logo":"redshift.png","homepage_url":"https://aws.amazon.com/redshift/","categories":["Cloud - AWS","Analytical Databases","Proprietary"],"pypi_packages":["sqlalchemy-redshift"],"connection_string":"redshift+psycopg2://{username}:{password}@{host}:5439/{database}","default_port":5439,"parameters":{"username":"Database username","password":"Database password","host":"AWS Endpoint","port":"Default 5439","database":"Database name"},"drivers":[{"name":"psycopg2","pypi_package":"psycopg2","connection_string":"redshift+psycopg2://{username}:{password}@{host}:5439/{database}","is_recommended":true},{"name":"redshift_connector","pypi_package":"redshift_connector","connection_string":"redshift+redshift_connector://{username}:{password}@{host}:5439/{database}","is_recommended":false,"notes":"Supports IAM-based credentials for clusters and serverless."}],"authentication_methods":[{"name":"IAM Credentials (Cluster)","description":"Use IAM-based temporary database credentials for Redshift clusters","requirements":"IAM role must have redshift:GetClusterCredentials permission","connection_string":"redshift+redshift_connector://","engine_parameters":{"connect_args":{"iam":true,"database":"","cluster_identifier":"","db_user":""}}},{"name":"IAM Role (Serverless)","description":"Authenticate using the IAM role attached to the environment (EC2 instance profile, ECS task role, etc.). No credentials needed.","requirements":"The attached IAM role must have redshift-serverless:GetCredentials and redshift-serverless:GetWorkgroup permissions.","connection_string":"redshift+redshift_connector://","engine_parameters":{"connect_args":{"iam":true,"is_serverless":true,"serverless_acct_id":"","serverless_work_group":"","database":"","user":"IAMR:"}}},{"name":"IAM Access Key (Serverless)","description":"Authenticate using explicit AWS access key and secret. Suitable for local development or CI environments without an attached IAM role.","requirements":"The IAM user must have redshift-serverless:GetCredentials and redshift-serverless:GetWorkgroup permissions.","connection_string":"redshift+redshift_connector://","engine_parameters":{"connect_args":{"iam":true,"is_serverless":true,"serverless_acct_id":"","serverless_work_group":"","database":"","host":"","port":5439,"region":"","access_key_id":"","secret_access_key":""}}}],"category":"Cloud - AWS","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"We were unable to connect to your database named \"%(database)s\". Please verify your database name and try again.","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]}]},"engine":"redshift","engine_name":"Amazon Redshift","engine_aliases":[],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"amazon_redshift","engine_name":"Amazon Redshift","module":"redshift","documentation":{"description":"Amazon Redshift is a fully managed data warehouse service.","logo":"redshift.png","homepage_url":"https://aws.amazon.com/redshift/","categories":["CLOUD_AWS","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["sqlalchemy-redshift"],"connection_string":"redshift+psycopg2://{username}:{password}@{host}:5439/{database}","default_port":5439,"parameters":{"username":"Database username","password":"Database password","host":"AWS Endpoint","port":"Default 5439","database":"Database name"},"drivers":[{"name":"psycopg2","pypi_package":"psycopg2","connection_string":"redshift+psycopg2://{username}:{password}@{host}:5439/{database}","is_recommended":true},{"name":"redshift_connector","pypi_package":"redshift_connector","connection_string":"redshift+redshift_connector://{username}:{password}@{host}:5439/{database}","is_recommended":false,"notes":"Supports IAM-based credentials for clusters and serverless."}],"authentication_methods":[{"name":"IAM Credentials (Cluster)","description":"Use IAM-based temporary database credentials for Redshift clusters","requirements":"IAM role must have redshift:GetClusterCredentials permission","connection_string":"redshift+redshift_connector://","engine_parameters":{"connect_args":{"iam":true,"database":"","cluster_identifier":"","db_user":""}}},{"name":"IAM Role (Serverless)","description":"Authenticate using the IAM role attached to the environment (EC2 instance profile, ECS task role, etc.). No credentials needed.","requirements":"The attached IAM role must have redshift-serverless:GetCredentials and redshift-serverless:GetWorkgroup permissions.","connection_string":"redshift+redshift_connector://","engine_parameters":{"connect_args":{"iam":true,"is_serverless":true,"serverless_acct_id":"","serverless_work_group":"","database":"","user":"IAMR:"}}},{"name":"IAM Access Key (Serverless)","description":"Authenticate using explicit AWS access key and secret. Suitable for local development or CI environments without an attached IAM role.","requirements":"The IAM user must have redshift-serverless:GetCredentials and redshift-serverless:GetWorkgroup permissions.","connection_string":"redshift+redshift_connector://","engine_parameters":{"connect_args":{"iam":true,"is_serverless":true,"serverless_acct_id":"","serverless_work_group":"","database":"","host":"","port":5439,"region":"","access_key_id":"","secret_access_key":""}}}],"custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"We were unable to connect to your database named \"%(database)s\". Please verify your database name and try again.","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]}]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-doris.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-doris.mdx index 0a247898693..9433e5b9980 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/apache-doris.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-doris.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.doris","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":79,"max_score":201,"documentation":{"description":"Apache Doris is a high-performance real-time analytical database.","logo":"doris.png","homepage_url":"https://doris.apache.org/","categories":["Apache Projects","Analytical Databases","Open Source"],"pypi_packages":["pydoris"],"connection_string":"doris://{username}:{password}@{host}:{port}/{catalog}.{database}","default_port":9030,"parameters":{"username":"User name","password":"Password","host":"Doris FE Host","port":"Doris FE port","catalog":"Catalog name","database":"Database name"},"category":"Apache Projects","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Unknown Doris server host \"%(hostname)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down and can't be reached.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"pydoris","engine_name":"Apache Doris","engine_aliases":["doris"],"default_driver":"pydoris","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"apache_doris","engine_name":"Apache Doris","module":"doris","documentation":{"description":"Apache Doris is a high-performance real-time analytical database.","logo":"doris.png","homepage_url":"https://doris.apache.org/","pypi_packages":["mysqlclient","pydoris"],"connection_string":"doris://{username}:{password}@{host}:{port}/{catalog}.{database}","default_port":9030,"parameters":{"username":"User name","password":"Password","host":"Doris FE Host","database":"Database name","port":"Doris FE port","catalog":"Catalog name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"categories":["APACHE_PROJECTS","ANALYTICAL_DATABASES","OPEN_SOURCE"],"custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Unknown Doris server host \"%(hostname)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down and can't be reached.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":79,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-drill.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-drill.mdx index 0add8712554..ebe76ab0255 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/apache-drill.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-drill.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.drill","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":50,"max_score":201,"documentation":{"description":"Apache Drill is a schema-free SQL query engine for Hadoop and NoSQL.","logo":"apache-drill.png","homepage_url":"https://drill.apache.org/","categories":["Apache Projects","Query Engines","Open Source"],"pypi_packages":["sqlalchemy-drill"],"connection_string":"drill+sadrill://{username}:{password}@{host}:{port}/{storage_plugin}?use_ssl=True","default_port":8047,"drivers":[{"name":"SQLAlchemy (REST)","pypi_package":"sqlalchemy-drill","connection_string":"drill+sadrill://{username}:{password}@{host}:{port}/{storage_plugin}?use_ssl=True","is_recommended":true},{"name":"JDBC","pypi_package":"sqlalchemy-drill","connection_string":"drill+jdbc://{username}:{password}@{host}:{port}","is_recommended":false,"notes":"Requires Drill JDBC Driver installation.","docs_url":"https://drill.apache.org/docs/using-the-jdbc-driver/"},{"name":"ODBC","pypi_package":"sqlalchemy-drill","is_recommended":false,"notes":"See Apache Drill documentation for ODBC setup.","docs_url":"https://drill.apache.org/docs/installing-the-driver-on-linux/"}],"connection_examples":[{"description":"Local embedded mode","connection_string":"drill+sadrill://localhost:8047/dfs?use_ssl=False"}],"category":"Apache Projects"},"engine":"drill","engine_name":"Apache Drill","engine_aliases":[],"default_driver":"sadrill","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"apache_drill","engine_name":"Apache Drill","module":"drill","documentation":{"description":"Apache Drill is a schema-free SQL query engine for Hadoop and NoSQL.","logo":"apache-drill.png","homepage_url":"https://drill.apache.org/","categories":["APACHE_PROJECTS","QUERY_ENGINES","OPEN_SOURCE"],"pypi_packages":["sqlalchemy-drill"],"connection_string":"drill+sadrill://{username}:{password}@{host}:{port}/{storage_plugin}?use_ssl=True","default_port":8047,"drivers":[{"name":"SQLAlchemy (REST)","pypi_package":"sqlalchemy-drill","connection_string":"drill+sadrill://{username}:{password}@{host}:{port}/{storage_plugin}?use_ssl=True","is_recommended":true},{"name":"JDBC","pypi_package":"sqlalchemy-drill","connection_string":"drill+jdbc://{username}:{password}@{host}:{port}","is_recommended":false,"notes":"Requires Drill JDBC Driver installation.","docs_url":"https://drill.apache.org/docs/using-the-jdbc-driver/"},{"name":"ODBC","pypi_package":"sqlalchemy-drill","is_recommended":false,"notes":"See Apache Drill documentation for ODBC setup.","docs_url":"https://drill.apache.org/docs/installing-the-driver-on-linux/"}],"connection_examples":[{"description":"Local embedded mode","connection_string":"drill+sadrill://localhost:8047/dfs?use_ssl=False"}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":50,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":true,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-druid.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-druid.mdx index 022c0a95267..4c39c53ad88 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/apache-druid.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-druid.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.druid","limit_method":1,"limit_clause":true,"joins":false,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":47,"max_score":201,"documentation":{"description":"Apache Druid is a high performance real-time analytics database.","logo":"druid.png","homepage_url":"https://druid.apache.org/","categories":["Apache Projects","Time Series Databases","Open Source"],"pypi_packages":["pydruid"],"connection_string":"druid://{username}:{password}@{host}:{port}/druid/v2/sql","default_port":9088,"parameters":{"username":"Database username","password":"Database password","host":"IP address or URL of the host","port":"Default 9088"},"ssl_configuration":{"custom_certificate":"Add certificate in Root Certificate field. pydruid will automatically use https.","disable_ssl_verification":{"engine_params":{"connect_args":{"scheme":"https","ssl_verify_cert":false}}}},"advanced_features":{"aggregations":"Define common aggregations in datasource edit view under List Druid Column tab.","post_aggregations":"Create metrics with postagg as Metric Type and provide valid JSON post-aggregation definition."},"notes":"A native Druid connector ships with Superset (behind DRUID_IS_ACTIVE flag) but SQLAlchemy connector via pydruid is preferred.","compatible_databases":[{"name":"Imply","description":"Imply is a fully-managed cloud platform and enterprise distribution built on Apache Druid. It provides real-time analytics with enterprise security and support.","logo":"imply.png","homepage_url":"https://imply.io/","categories":["Time Series Databases","Cloud Data Warehouses","Hosted Open Source"],"pypi_packages":["pydruid"],"connection_string":"druid://{username}:{password}@{host}/druid/v2/sql","docs_url":"https://docs.imply.io/"}],"category":"Apache Projects"},"engine":"druid","engine_name":"Apache Druid","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"apache_druid","engine_name":"Apache Druid","module":"druid","documentation":{"description":"Apache Druid is a high performance real-time analytics database.","logo":"druid.png","homepage_url":"https://druid.apache.org/","categories":["APACHE_PROJECTS","TIME_SERIES","OPEN_SOURCE"],"pypi_packages":["pydruid"],"connection_string":"druid://{username}:{password}@{host}:{port}/druid/v2/sql","default_port":9088,"parameters":{"username":"Database username","password":"Database password","host":"IP address or URL of the host","port":"Default 9088"},"ssl_configuration":{"custom_certificate":"Add certificate in Root Certificate field. pydruid will automatically use https.","disable_ssl_verification":{"engine_params":{"connect_args":{"scheme":"https","ssl_verify_cert":false}}}},"advanced_features":{"aggregations":"Define common aggregations in datasource edit view under List Druid Column tab.","post_aggregations":"Create metrics with postagg as Metric Type and provide valid JSON post-aggregation definition."},"notes":"A native Druid connector ships with Superset (behind DRUID_IS_ACTIVE flag) but SQLAlchemy connector via pydruid is preferred.","compatible_databases":[{"name":"Imply","description":"Imply is a fully-managed cloud platform and enterprise distribution built on Apache Druid. It provides real-time analytics with enterprise security and support.","logo":"imply.png","homepage_url":"https://imply.io/","categories":["TIME_SERIES","CLOUD_DATA_WAREHOUSES","HOSTED_OPEN_SOURCE"],"pypi_packages":["pydruid"],"connection_string":"druid://{username}:{password}@{host}/druid/v2/sql","docs_url":"https://docs.imply.io/"}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":47,"max_score":201,"joins":false,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-hive.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-hive.mdx index a23e84d1d98..48821c742e8 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/apache-hive.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-hive.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.hive","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":false,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":767,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":true,"expand_data":true,"query_cost_estimation":true,"sql_validation":false,"score":140,"max_score":201,"documentation":{"description":"Apache Hive is a data warehouse infrastructure built on Hadoop.","logo":"apache-hive.svg","homepage_url":"https://hive.apache.org/","categories":["Apache Projects","Query Engines","Open Source"],"pypi_packages":["pyhive"],"connection_string":"hive://hive@{hostname}:{port}/{database}","default_port":10000,"category":"Apache Projects"},"engine":"hive","engine_name":"Apache Hive","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"apache_hive","engine_name":"Apache Hive","module":"hive","documentation":{"description":"Apache Hive is a data warehouse infrastructure built on Hadoop.","logo":"apache-hive.svg","homepage_url":"https://hive.apache.org/","pypi_packages":["pyhive","pyhive"],"install_instructions":"pip install \"apache-superset[presto]\"","connection_string":"hive://hive@{hostname}:{port}/{database}","default_port":10000,"parameters":{"hostname":"Presto coordinator hostname","port":"Presto coordinator port (default 8080)","database":"Catalog name"},"drivers":[{"name":"PyHive","pypi_package":"pyhive","connection_string":"presto://{hostname}:{port}/{database}","is_recommended":true}],"categories":["APACHE_PROJECTS","QUERY_ENGINES","OPEN_SOURCE"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":140,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":true,"query_cost_estimation":true,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-impala.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-impala.mdx index cf2ca004342..3730c679bd6 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/apache-impala.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-impala.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.impala","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":37,"max_score":201,"documentation":{"description":"Apache Impala is an open-source massively parallel processing SQL query engine.","logo":"apache-impala.png","homepage_url":"https://impala.apache.org/","categories":["Apache Projects","Query Engines","Open Source"],"pypi_packages":["impyla"],"connection_string":"impala://{hostname}:{port}/{database}","default_port":21050,"category":"Apache Projects"},"engine":"impala","engine_name":"Apache Impala","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"apache_impala","engine_name":"Apache Impala","module":"impala","documentation":{"description":"Apache Impala is an open-source massively parallel processing SQL query engine.","logo":"apache-impala.png","homepage_url":"https://impala.apache.org/","categories":["APACHE_PROJECTS","QUERY_ENGINES","OPEN_SOURCE"],"pypi_packages":["impyla"],"connection_string":"impala://{hostname}:{port}/{database}","default_port":21050},"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":37,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-iotdb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-iotdb.mdx index 875b0af119d..66c7d504eba 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/apache-iotdb.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-iotdb.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":false,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":false,"SIX_HOURS":false,"DAY":false,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":false,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":false},"module":"superset.db_engine_specs.iotdb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":20,"max_score":201,"documentation":{"description":"Apache IoTDB is a time series database designed for IoT data, with efficient storage and query capabilities for massive time series data.","logo":"apache-iotdb.svg","homepage_url":"https://iotdb.apache.org/","categories":["Apache Projects","Time Series Databases","Open Source"],"pypi_packages":["apache-iotdb"],"connection_string":"iotdb://{username}:{password}@{hostname}:{port}","default_port":6667,"parameters":{"username":"Database username (default: root)","password":"Database password (default: root)","hostname":"IP address or hostname","port":"Default 6667"},"notes":"The IoTDB SQLAlchemy dialect was written to integrate with Apache Superset. IoTDB uses a hierarchical data model, which is reorganized into a relational model for SQL queries.","category":"Apache Projects"},"engine":"iotdb","engine_name":"Apache IoTDB","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"apache_iotdb","engine_name":"Apache IoTDB","module":"iotdb","documentation":{"description":"Apache IoTDB is a time series database designed for IoT data, with efficient storage and query capabilities for massive time series data.","logo":"apache-iotdb.svg","homepage_url":"https://iotdb.apache.org/","categories":["APACHE_PROJECTS","TIME_SERIES","OPEN_SOURCE"],"pypi_packages":["apache-iotdb"],"connection_string":"iotdb://{username}:{password}@{hostname}:{port}","default_port":6667,"parameters":{"username":"Database username (default: root)","password":"Database password (default: root)","hostname":"IP address or hostname","port":"Default 6667"},"notes":"The IoTDB SQLAlchemy dialect was written to integrate with Apache Superset. IoTDB uses a hierarchical data model, which is reorganized into a relational model for SQL queries."},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-kylin.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-kylin.mdx index e2ca814d8e7..a6bbb5aac4b 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/apache-kylin.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-kylin.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.kylin","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Apache Kylin is an open-source OLAP engine for big data.","logo":"apache-kylin.png","homepage_url":"https://kylin.apache.org/","categories":["Apache Projects","Analytical Databases","Open Source"],"pypi_packages":["kylinpy"],"connection_string":"kylin://{username}:{password}@{hostname}:{port}/{project}?{param1}={value1}&{param2}={value2}","default_port":7070,"category":"Apache Projects"},"engine":"kylin","engine_name":"Apache Kylin","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"apache_kylin","engine_name":"Apache Kylin","module":"kylin","documentation":{"description":"Apache Kylin is an open-source OLAP engine for big data.","logo":"apache-kylin.png","homepage_url":"https://kylin.apache.org/","categories":["APACHE_PROJECTS","ANALYTICAL_DATABASES","OPEN_SOURCE"],"pypi_packages":["kylinpy"],"connection_string":"kylin://{username}:{password}@{hostname}:{port}/{project}?{param1}={value1}&{param2}={value2}","default_port":7070},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-phoenix.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-phoenix.mdx index bb97d9a89fd..6cfb1c1bae6 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/apache-phoenix.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-phoenix.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.phoenix","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Apache Phoenix is a relational database layer over Apache HBase, providing low-latency SQL queries over HBase data.","logo":"apache-phoenix.png","homepage_url":"https://phoenix.apache.org/","categories":["Apache Projects","Analytical Databases","Open Source"],"pypi_packages":["phoenixdb"],"connection_string":"phoenix://{hostname}:{port}/","default_port":8765,"notes":"Phoenix provides a SQL interface to Apache HBase. The phoenixdb driver connects via the Phoenix Query Server and supports a subset of SQLAlchemy.","category":"Apache Projects"},"engine":"phoenix","engine_name":"Apache Phoenix","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"apache_phoenix","engine_name":"Apache Phoenix","module":"phoenix","documentation":{"description":"Apache Phoenix is a relational database layer over Apache HBase, providing low-latency SQL queries over HBase data.","logo":"apache-phoenix.png","homepage_url":"https://phoenix.apache.org/","categories":["APACHE_PROJECTS","ANALYTICAL_DATABASES","OPEN_SOURCE"],"pypi_packages":["phoenixdb"],"connection_string":"phoenix://{hostname}:{port}/","default_port":8765,"notes":"Phoenix provides a SQL interface to Apache HBase. The phoenixdb driver connects via the Phoenix Query Server and supports a subset of SQLAlchemy."},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-pinot.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-pinot.mdx index e486d1d72cd..9380e87b843 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/apache-pinot.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-pinot.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.pinot","limit_method":1,"limit_clause":true,"joins":false,"subqueries":false,"alias_in_select":false,"alias_in_orderby":false,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":32,"max_score":201,"documentation":{"description":"Apache Pinot is a real-time distributed OLAP datastore.","logo":"apache-pinot.svg","homepage_url":"https://pinot.apache.org/","categories":["Apache Projects","Time Series Databases","Open Source"],"pypi_packages":["pinotdb"],"connection_string":"pinot+http://{broker_host}:{broker_port}/query?controller=http://{controller_host}:{controller_port}/","default_port":8099,"connection_examples":[{"description":"With authentication","connection_string":"pinot://{username}:{password}@{broker_host}:{broker_port}/query/sql?controller=http://{controller_host}:{controller_port}/verify_ssl=true"}],"engine_parameters":[{"name":"Multi-stage Query Engine","description":"Enable for Explore view, joins, window functions","json":{"connect_args":{"use_multistage_engine":"true"}},"docs_url":"https://docs.pinot.apache.org/reference/multi-stage-engine"}],"category":"Apache Projects"},"engine":"pinot","engine_name":"Apache Pinot","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"apache_pinot","engine_name":"Apache Pinot","module":"pinot","documentation":{"description":"Apache Pinot is a real-time distributed OLAP datastore.","logo":"apache-pinot.svg","homepage_url":"https://pinot.apache.org/","categories":["APACHE_PROJECTS","TIME_SERIES","OPEN_SOURCE"],"pypi_packages":["pinotdb"],"connection_string":"pinot+http://{broker_host}:{broker_port}/query?controller=http://{controller_host}:{controller_port}/","default_port":8099,"connection_examples":[{"description":"With authentication","connection_string":"pinot://{username}:{password}@{broker_host}:{broker_port}/query/sql?controller=http://{controller_host}:{controller_port}/verify_ssl=true"}],"engine_parameters":[{"name":"Multi-stage Query Engine","description":"Enable for Explore view, joins, window functions","json":{"connect_args":{"use_multistage_engine":"true"}},"docs_url":"https://docs.pinot.apache.org/reference/multi-stage-engine"}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":32,"max_score":201,"joins":false,"subqueries":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-solr.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-solr.mdx index 8f4b67c67a3..987b058119a 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/apache-solr.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-solr.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":false,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":false,"SIX_HOURS":false,"DAY":false,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":false,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":false},"module":"superset.db_engine_specs.solr","limit_method":1,"limit_clause":true,"joins":false,"subqueries":false,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":20,"max_score":201,"documentation":{"description":"Apache Solr is an open-source enterprise search platform.","logo":"apache-solr.png","homepage_url":"https://solr.apache.org/","categories":["Apache Projects","Search & NoSQL","Open Source"],"pypi_packages":["sqlalchemy-solr"],"connection_string":"solr://{username}:{password}@{host}:{port}/{server_path}/{collection}[/?use_ssl=true|false]","default_port":8983,"category":"Apache Projects"},"engine":"solr","engine_name":"Apache Solr","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"apache_solr","engine_name":"Apache Solr","module":"solr","documentation":{"description":"Apache Solr is an open-source enterprise search platform.","logo":"apache-solr.png","homepage_url":"https://solr.apache.org/","categories":["APACHE_PROJECTS","SEARCH_NOSQL","OPEN_SOURCE"],"pypi_packages":["sqlalchemy-solr"],"connection_string":"solr://{username}:{password}@{host}:{port}/{server_path}/{collection}[/?use_ssl=true|false]","default_port":8983},"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":false,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":false,"SIX_HOURS":false,"DAY":false,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":false,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":false},"score":20,"max_score":201,"joins":false,"subqueries":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/apache-spark-sql.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/apache-spark-sql.mdx index cac43db726c..cab583d3a20 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/apache-spark-sql.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/apache-spark-sql.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.spark","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":false,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":767,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":true,"expand_data":true,"query_cost_estimation":true,"sql_validation":false,"score":140,"max_score":201,"documentation":{"description":"Apache Spark SQL is a module for structured data processing.","logo":"apache-spark.png","homepage_url":"https://spark.apache.org/sql/","categories":["Apache Projects","Query Engines","Open Source"],"pypi_packages":["pyhive"],"connection_string":"hive://hive@{hostname}:{port}/{database}","default_port":10000,"category":"Apache Projects"},"engine":"hive","engine_name":"Apache Spark SQL","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"apache_spark_sql","engine_name":"Apache Spark SQL","module":"spark","documentation":{"description":"Apache Spark SQL is a module for structured data processing.","logo":"apache-spark.png","homepage_url":"https://spark.apache.org/sql/","pypi_packages":["pyhive","pyhive","pyhive"],"install_instructions":"pip install \"apache-superset[presto]\"","connection_string":"hive://hive@{hostname}:{port}/{database}","default_port":10000,"parameters":{"hostname":"Presto coordinator hostname","port":"Presto coordinator port (default 8080)","database":"Catalog name"},"drivers":[{"name":"PyHive","pypi_package":"pyhive","connection_string":"presto://{hostname}:{port}/{database}","is_recommended":true}],"categories":["APACHE_PROJECTS","QUERY_ENGINES","OPEN_SOURCE"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":140,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":true,"query_cost_estimation":true,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/arc.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/arc.mdx index a76acda681f..17b432fe6cc 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/arc.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/arc.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.arc","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Arc is a data platform with multiple connection options.","categories":["Other Databases","Proprietary"],"pypi_packages":["arc-superset-arrow"],"connection_string":"arc+arrow://{api_key}@{hostname}:{port}/{database}","parameters":{"api_key":"Arc API key","hostname":"Arc hostname","port":"Arc port","database":"Database name"},"drivers":[{"name":"Apache Arrow (Recommended)","pypi_package":"arc-superset-arrow","connection_string":"arc+arrow://{api_key}@{hostname}:{port}/{database}","is_recommended":true,"notes":"Recommended for production. Provides 3-5x better performance using Apache Arrow IPC."},{"name":"JSON","pypi_package":"arc-superset-dialect","connection_string":"arc+json://{api_key}@{hostname}:{port}/{database}","is_recommended":false}],"notes":"Arc supports multiple databases (schemas) within a single instance. Each Arc database appears as a schema in SQL Lab.","category":"Other Databases"},"engine":"arc","engine_name":"Arc","engine_aliases":[],"default_driver":"arrow","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"arc","engine_name":"Arc","module":"arc","documentation":{"description":"Arc is a data platform with multiple connection options.","categories":["OTHER","PROPRIETARY"],"pypi_packages":["arc-superset-arrow"],"connection_string":"arc+arrow://{api_key}@{hostname}:{port}/{database}","parameters":{"api_key":"Arc API key","hostname":"Arc hostname","port":"Arc port","database":"Database name"},"drivers":[{"name":"Apache Arrow (Recommended)","pypi_package":"arc-superset-arrow","connection_string":"arc+arrow://{api_key}@{hostname}:{port}/{database}","is_recommended":true,"notes":"Recommended for production. Provides 3-5x better performance using Apache Arrow IPC."},{"name":"JSON","pypi_package":"arc-superset-dialect","connection_string":"arc+json://{api_key}@{hostname}:{port}/{database}","is_recommended":false}],"notes":"Arc supports multiple databases (schemas) within a single instance. Each Arc database appears as a schema in SQL Lab."},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/ascend.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/ascend.mdx index b86844bda29..b59aef97a77 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/ascend.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/ascend.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.ascend","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":38,"max_score":201,"documentation":{"description":"Ascend.io is a data automation platform for building data pipelines.","logo":"ascend.webp","homepage_url":"https://www.ascend.io/","categories":["Cloud Data Warehouses","Analytical Databases","Hosted Open Source"],"pypi_packages":["impyla"],"connection_string":"ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true","category":"Other Databases"},"engine":"ascend","engine_name":"Ascend","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"ascend","engine_name":"Ascend","module":"ascend","documentation":{"description":"Ascend.io is a data automation platform for building data pipelines.","logo":"ascend.webp","homepage_url":"https://www.ascend.io/","pypi_packages":["impyla","impyla"],"connection_string":"ascend://{username}:{password}@{hostname}:{port}/{database}?auth_mechanism=PLAIN;use_ssl=true","default_port":21050,"categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","HOSTED_OPEN_SOURCE"]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql-data-api.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql-data-api.mdx index cc67ad0cbc6..6e46fb2c501 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql-data-api.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql-data-api.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.aurora","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":59,"max_score":201,"documentation":{"description":"MySQL is a popular open-source relational database.","logo":"mysql.png","homepage_url":"https://www.mysql.com/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"compatible_databases":[{"name":"MariaDB","description":"MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.","logo":"mariadb.png","homepage_url":"https://mariadb.org/","pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}:{port}/{database}","categories":["Open Source"]},{"name":"Amazon Aurora MySQL","description":"Amazon Aurora MySQL is a fully managed, MySQL-compatible relational database with up to 5x the throughput of standard MySQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"mysql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard MySQL connections also work with mysqlclient.","categories":["Cloud - AWS","Hosted Open Source"]}],"category":"Traditional RDBMS"},"engine":"mysql","engine_name":"Aurora MySQL (Data API)","engine_aliases":[],"default_driver":"auroradataapi","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"aurora_mysql_(data_api)","engine_name":"Aurora MySQL (Data API)","module":"aurora","documentation":{"description":"MySQL is a popular open-source relational database.","logo":"mysql.png","homepage_url":"https://www.mysql.com/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql.mdx index c3e0aab3404..182a47887c3 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-mysql.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.aurora","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":59,"max_score":201,"documentation":{"description":"MySQL is a popular open-source relational database.","logo":"mysql.png","homepage_url":"https://www.mysql.com/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"compatible_databases":[{"name":"MariaDB","description":"MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.","logo":"mariadb.png","homepage_url":"https://mariadb.org/","pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}:{port}/{database}","categories":["Open Source"]},{"name":"Amazon Aurora MySQL","description":"Amazon Aurora MySQL is a fully managed, MySQL-compatible relational database with up to 5x the throughput of standard MySQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"mysql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard MySQL connections also work with mysqlclient.","categories":["Cloud - AWS","Hosted Open Source"]}],"category":"Traditional RDBMS"},"engine":"mysql","engine_name":"Aurora MySQL","engine_aliases":[],"default_driver":"mysqldb","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"aurora_mysql","engine_name":"Aurora MySQL","module":"aurora","documentation":{"description":"MySQL is a popular open-source relational database.","logo":"mysql.png","homepage_url":"https://www.mysql.com/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql-data-api.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql-data-api.mdx index 8e3df32833d..e151811ff61 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql-data-api.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql-data-api.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.aurora","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":63,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":true,"sql_validation":true,"score":104,"max_score":201,"documentation":{"description":"PostgreSQL is an advanced open-source relational database.","logo":"postgresql.svg","homepage_url":"https://www.postgresql.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://www.postgresql.org/docs/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","compatible_databases":[{"name":"Hologres","description":"Alibaba Cloud real-time interactive analytics service, fully compatible with PostgreSQL 11.","logo":"hologres.png","homepage_url":"https://www.alibabacloud.com/product/hologres","pypi_packages":["psycopg2"],"connection_string":"postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"AccessKey ID of your Alibaba Cloud account","password":"AccessKey secret of your Alibaba Cloud account","host":"Public endpoint of the Hologres instance","port":"Port number of the Hologres instance","database":"Name of the Hologres database"},"categories":["Proprietary"]},{"name":"TimescaleDB","description":"Open-source relational database for time-series and analytics, built on PostgreSQL.","logo":"timescale.png","homepage_url":"https://www.timescale.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Timescale Cloud (SSL required)","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://docs.timescale.com/","categories":["Open Source"]},{"name":"YugabyteDB","description":"Distributed SQL database built on top of PostgreSQL.","logo":"yugabyte.png","homepage_url":"https://www.yugabyte.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://www.yugabyte.com/","categories":["Open Source"]},{"name":"Supabase","description":"Open-source Firebase alternative built on top of PostgreSQL, providing a full backend-as-a-service with a hosted Postgres database.","logo":"supabase.svg","homepage_url":"https://supabase.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Supabase project (connection pooler)","connection_string":"postgresql://{username}.{project_ref}:{password}@aws-0-{region}.pooler.supabase.com:6543/{database}"}],"parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"Supabase project host (from project settings)","port":"Default 5432 (direct) or 6543 (pooler)","database":"Database name (default: postgres)","project_ref":"Supabase project reference (from project settings)","region":"Supabase project region (e.g., us-east-1)"},"notes":"Find connection details in your Supabase project dashboard under Settings > Database. Use the connection pooler (port 6543) for better connection management.","docs_url":"https://supabase.com/docs/guides/database/connecting-to-postgres","categories":["Hosted Open Source"]},{"name":"Google AlloyDB","description":"Google Cloud's PostgreSQL-compatible database service for demanding transactional and analytical workloads.","logo":"alloydb.png","homepage_url":"https://cloud.google.com/alloydb","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"AlloyDB instance IP or Auth Proxy address","port":"Default 5432","database":"Database name"},"notes":"For public IP connections, use the AlloyDB Auth Proxy for secure access. Private IP connections can connect directly.","docs_url":"https://cloud.google.com/alloydb/docs","categories":["Cloud - Google","Hosted Open Source"]},{"name":"Neon","description":"Serverless PostgreSQL with branching, scale-to-zero, and bottomless storage.","logo":"neon.png","homepage_url":"https://neon.tech/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}/{database}?sslmode=require","parameters":{"username":"Neon role name","password":"Neon role password","host":"Neon hostname (e.g., ep-cool-name-123456.us-east-2.aws.neon.tech)","database":"Database name (default: neondb)"},"notes":"SSL is required for all connections. Find connection details in the Neon console under Connection Details.","docs_url":"https://neon.tech/docs/connect/connect-from-any-app","categories":["Hosted Open Source"]},{"name":"Amazon Aurora PostgreSQL","description":"Amazon Aurora PostgreSQL is a fully managed, PostgreSQL-compatible relational database with up to 5x the throughput of standard PostgreSQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"postgresql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard PostgreSQL connections also work with psycopg2.","categories":["Cloud - AWS","Hosted Open Source"]}],"category":"Traditional RDBMS"},"engine":"postgresql","engine_name":"Aurora PostgreSQL (Data API)","engine_aliases":["postgres"],"default_driver":"auroradataapi","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"aurora_postgresql_(data_api)","engine_name":"Aurora PostgreSQL (Data API)","module":"aurora","documentation":{"description":"PostgreSQL is an advanced open-source relational database.","logo":"postgresql.svg","homepage_url":"https://www.postgresql.org/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://www.postgresql.org/docs/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html"},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql.mdx index 68d194d08ab..4d53cd80470 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/aurora-postgresql.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.aurora","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":63,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":true,"sql_validation":true,"score":104,"max_score":201,"documentation":{"description":"PostgreSQL is an advanced open-source relational database.","logo":"postgresql.svg","homepage_url":"https://www.postgresql.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://www.postgresql.org/docs/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","compatible_databases":[{"name":"Hologres","description":"Alibaba Cloud real-time interactive analytics service, fully compatible with PostgreSQL 11.","logo":"hologres.png","homepage_url":"https://www.alibabacloud.com/product/hologres","pypi_packages":["psycopg2"],"connection_string":"postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"AccessKey ID of your Alibaba Cloud account","password":"AccessKey secret of your Alibaba Cloud account","host":"Public endpoint of the Hologres instance","port":"Port number of the Hologres instance","database":"Name of the Hologres database"},"categories":["Proprietary"]},{"name":"TimescaleDB","description":"Open-source relational database for time-series and analytics, built on PostgreSQL.","logo":"timescale.png","homepage_url":"https://www.timescale.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Timescale Cloud (SSL required)","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://docs.timescale.com/","categories":["Open Source"]},{"name":"YugabyteDB","description":"Distributed SQL database built on top of PostgreSQL.","logo":"yugabyte.png","homepage_url":"https://www.yugabyte.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://www.yugabyte.com/","categories":["Open Source"]},{"name":"Supabase","description":"Open-source Firebase alternative built on top of PostgreSQL, providing a full backend-as-a-service with a hosted Postgres database.","logo":"supabase.svg","homepage_url":"https://supabase.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Supabase project (connection pooler)","connection_string":"postgresql://{username}.{project_ref}:{password}@aws-0-{region}.pooler.supabase.com:6543/{database}"}],"parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"Supabase project host (from project settings)","port":"Default 5432 (direct) or 6543 (pooler)","database":"Database name (default: postgres)","project_ref":"Supabase project reference (from project settings)","region":"Supabase project region (e.g., us-east-1)"},"notes":"Find connection details in your Supabase project dashboard under Settings > Database. Use the connection pooler (port 6543) for better connection management.","docs_url":"https://supabase.com/docs/guides/database/connecting-to-postgres","categories":["Hosted Open Source"]},{"name":"Google AlloyDB","description":"Google Cloud's PostgreSQL-compatible database service for demanding transactional and analytical workloads.","logo":"alloydb.png","homepage_url":"https://cloud.google.com/alloydb","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"AlloyDB instance IP or Auth Proxy address","port":"Default 5432","database":"Database name"},"notes":"For public IP connections, use the AlloyDB Auth Proxy for secure access. Private IP connections can connect directly.","docs_url":"https://cloud.google.com/alloydb/docs","categories":["Cloud - Google","Hosted Open Source"]},{"name":"Neon","description":"Serverless PostgreSQL with branching, scale-to-zero, and bottomless storage.","logo":"neon.png","homepage_url":"https://neon.tech/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}/{database}?sslmode=require","parameters":{"username":"Neon role name","password":"Neon role password","host":"Neon hostname (e.g., ep-cool-name-123456.us-east-2.aws.neon.tech)","database":"Database name (default: neondb)"},"notes":"SSL is required for all connections. Find connection details in the Neon console under Connection Details.","docs_url":"https://neon.tech/docs/connect/connect-from-any-app","categories":["Hosted Open Source"]},{"name":"Amazon Aurora PostgreSQL","description":"Amazon Aurora PostgreSQL is a fully managed, PostgreSQL-compatible relational database with up to 5x the throughput of standard PostgreSQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"postgresql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard PostgreSQL connections also work with psycopg2.","categories":["Cloud - AWS","Hosted Open Source"]}],"category":"Traditional RDBMS"},"engine":"postgresql","engine_name":"Aurora PostgreSQL","engine_aliases":["postgres"],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"aurora_postgresql","engine_name":"Aurora PostgreSQL","module":"aurora","documentation":{"description":"PostgreSQL is an advanced open-source relational database.","logo":"postgresql.svg","homepage_url":"https://www.postgresql.org/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://www.postgresql.org/docs/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html"},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer-kql.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer-kql.mdx deleted file mode 100644 index 9baa0e25a09..00000000000 --- a/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer-kql.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Azure Data Explorer (KQL) -sidebar_label: Azure Data Explorer (KQL) -description: "Documentation for Azure Data Explorer (KQL) database connection." -hide_title: true ---- - -{/* -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF 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. -*/} - -import { DatabasePage } from '@site/src/components/databases'; - -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.kusto","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":false,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":40,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"engine+driver://user:password@host:port/dbname[?key=value&key=value...]","category":"Cloud - Azure"},"engine":"kustokql","engine_name":"Azure Data Explorer (KQL)","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; - - diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer.mdx index c19d81cb611..6b94d858f07 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/azure-data-explorer.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.kusto","limit_method":2,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":false,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":54,"max_score":201,"documentation":{"description":"Azure Data Explorer (Kusto) is a fast, fully managed data analytics service from Microsoft Azure. Query data using SQL or native KQL syntax.","logo":"kusto.png","homepage_url":"https://azure.microsoft.com/en-us/products/data-explorer/","categories":["Cloud - Azure","Analytical Databases","Proprietary"],"pypi_packages":["sqlalchemy-kusto"],"connection_string":"kustosql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}","parameters":{"cluster":"Azure Data Explorer cluster name","database":"Database name","client_id":"Azure AD application (client) ID","client_secret":"Azure AD application secret","tenant_id":"Azure AD tenant ID"},"drivers":[{"name":"SQL Interface (Recommended)","pypi_package":"sqlalchemy-kusto","connection_string":"kustosql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}","is_recommended":true,"notes":"Use familiar SQL syntax to query Azure Data Explorer."},{"name":"KQL (Kusto Query Language)","pypi_package":"sqlalchemy-kusto","connection_string":"kustokql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}","is_recommended":false,"notes":"Use native Kusto Query Language for advanced analytics."}],"category":"Cloud - Azure"},"engine":"kustosql","engine_name":"Azure Data Explorer","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"azure_data_explorer","engine_name":"Azure Data Explorer","module":"kusto","documentation":{"description":"Azure Data Explorer (Kusto) is a fast, fully managed data analytics service from Microsoft Azure. Query data using SQL or native KQL syntax.","logo":"kusto.png","homepage_url":"https://azure.microsoft.com/en-us/products/data-explorer/","categories":["CLOUD_AZURE","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["sqlalchemy-kusto"],"connection_string":"kustosql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}","parameters":{"cluster":"Azure Data Explorer cluster name","database":"Database name","client_id":"Azure AD application (client) ID","client_secret":"Azure AD application secret","tenant_id":"Azure AD tenant ID"},"drivers":[{"name":"SQL Interface (Recommended)","pypi_package":"sqlalchemy-kusto","connection_string":"kustosql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}","is_recommended":true,"notes":"Use familiar SQL syntax to query Azure Data Explorer."},{"name":"KQL (Kusto Query Language)","pypi_package":"sqlalchemy-kusto","connection_string":"kustokql+https://{cluster}.kusto.windows.net/{database}?msi=False&azure_ad_client_id={client_id}&azure_ad_client_secret={client_secret}&azure_ad_tenant_id={tenant_id}","is_recommended":false,"notes":"Use native Kusto Query Language for advanced analytics."}]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/azure-synapse.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/azure-synapse.mdx index d4af047b3e2..f075759d7a0 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/azure-synapse.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/azure-synapse.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.mssql","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":false,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":44,"max_score":201,"documentation":{"description":"Azure Synapse Analytics is a cloud-based enterprise data warehouse from Microsoft that combines big data and data warehousing.","logo":"azure.svg","homepage_url":"https://azure.microsoft.com/en-us/products/synapse-analytics/","categories":["Cloud Data Warehouses","Analytical Databases","Proprietary"],"pypi_packages":["pymssql"],"connection_string":"mssql+pymssql://{username}@{server}:{password}@{server}.database.windows.net:1433/{database}","category":"Cloud - Azure","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\", password, or database name \"%(database)s\" is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]}]},"engine":"mssql","engine_name":"Azure Synapse","engine_aliases":[],"default_driver":"pyodbc","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"azure_synapse","engine_name":"Azure Synapse","module":"mssql","documentation":{"description":"Azure Synapse Analytics is a cloud-based enterprise data warehouse from Microsoft that combines big data and data warehousing.","logo":"azure.svg","homepage_url":"https://azure.microsoft.com/en-us/products/synapse-analytics/","pypi_packages":["pymssql","pymssql"],"connection_string":"mssql+pymssql://{username}@{server}:{password}@{server}.database.windows.net:1433/{database}","default_port":1433,"drivers":[{"name":"pymssql","pypi_package":"pymssql","connection_string":"mssql+pymssql://{username}:{password}@{host}:{port}/{database}","is_recommended":true},{"name":"pyodbc","pypi_package":"pyodbc","connection_string":"mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3C{host}%3E%2C1433%3BDatabase%3D{database}%3BUid%3D{username}%3BPwd%3D{password}%3BEncrypt%3Dyes%3BConnection+Timeout%3D30","is_recommended":false,"notes":"Connection string must be URL-encoded. Special characters like @ need encoding."}],"docs_url":"https://docs.sqlalchemy.org/en/20/core/engines.html#escaping-special-characters-such-as-signs-in-passwords","categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","PROPRIETARY"],"custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\", password, or database name \"%(database)s\" is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]}]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/base.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/base.mdx deleted file mode 100644 index 7dd1c23b108..00000000000 --- a/docs/versioned_docs/version-6.1.0/databases/supported/base.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: base -sidebar_label: base -description: "Documentation for base database connection." -hide_title: true ---- - -{/* -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF 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. -*/} - -import { DatabasePage } from '@site/src/components/databases'; - -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.presto","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":true,"expand_data":false,"query_cost_estimation":true,"sql_validation":false,"score":109,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"engine+driver://user:password@host:port/dbname[?key=value&key=value...]","category":"Other Databases","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table_name)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema_name)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_ERROR","message_template":"Unable to connect to catalog named \"%(catalog_name)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015]}]},"engine":"base","engine_name":"base","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; - - diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse-sqlalchemy.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse-sqlalchemy.mdx deleted file mode 100644 index 5efc6accf42..00000000000 --- a/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse-sqlalchemy.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: ClickHouse (sqlalchemy) -sidebar_label: ClickHouse (sqlalchemy) -description: "Documentation for ClickHouse (sqlalchemy) database connection." -hide_title: true ---- - -{/* -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF 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. -*/} - -import { DatabasePage } from '@site/src/components/databases'; - -export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.clickhouse","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":false,"file_upload":false,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":51,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"engine+driver://user:password@host:port/dbname[?key=value&key=value...]","category":"Analytical Databases"},"engine":"clickhouse","engine_name":"ClickHouse (sqlalchemy)","engine_aliases":[],"default_driver":null,"supports_file_upload":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; - - diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse.mdx index 5e458213981..e626efb06ae 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/clickhouse.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.clickhouse","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":false,"file_upload":false,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":61,"max_score":201,"documentation":{"description":"ClickHouse is an open-source column-oriented database for real-time analytics using SQL. It's known for extremely fast query performance on large datasets.","logo":"clickhouse.png","homepage_url":"https://clickhouse.com/","categories":["Analytical Databases","Open Source"],"pypi_packages":["clickhouse-connect>=0.13.0"],"connection_string":"clickhousedb://{username}:{password}@{host}:{port}/{database}","default_port":8123,"drivers":[{"name":"clickhouse-connect (Recommended)","pypi_package":"clickhouse-connect>=0.13.0","connection_string":"clickhousedb://{username}:{password}@{host}:{port}/{database}","is_recommended":true,"notes":"Official ClickHouse Python driver with native protocol support."},{"name":"clickhouse-sqlalchemy (Legacy)","pypi_package":"clickhouse-sqlalchemy","connection_string":"clickhouse://{username}:{password}@{host}:{port}/{database}","is_recommended":false,"notes":"Older driver using HTTP interface. Use clickhouse-connect for new deployments."}],"connection_examples":[{"description":"Altinity Cloud","connection_string":"clickhousedb://demo:demo@github.demo.trial.altinity.cloud/default?secure=true"},{"description":"Local (no auth, no SSL)","connection_string":"clickhousedb://localhost/default"}],"install_instructions":"echo \"clickhouse-connect>=0.13.0\" >> ./docker/requirements-local.txt","compatible_databases":[{"name":"ClickHouse Cloud","description":"ClickHouse Cloud is the official fully-managed cloud service for ClickHouse. It provides automatic scaling, built-in backups, and enterprise security features.","logo":"clickhouse.png","homepage_url":"https://clickhouse.cloud/","categories":["Analytical Databases","Cloud Data Warehouses","Hosted Open Source"],"pypi_packages":["clickhouse-connect>=0.13.0"],"connection_string":"clickhousedb://{username}:{password}@{host}:8443/{database}?secure=true","parameters":{"username":"ClickHouse Cloud username","password":"ClickHouse Cloud password","host":"Your ClickHouse Cloud hostname","database":"Database name (default)"},"docs_url":"https://clickhouse.com/docs/en/cloud"},{"name":"Altinity.Cloud","description":"Altinity.Cloud is a managed ClickHouse service providing Kubernetes-native deployments with enterprise support.","logo":"altinity.png","homepage_url":"https://altinity.cloud/","categories":["Analytical Databases","Cloud Data Warehouses","Hosted Open Source"],"pypi_packages":["clickhouse-connect>=0.13.0"],"connection_string":"clickhousedb://{username}:{password}@{host}/{database}?secure=true","docs_url":"https://docs.altinity.com/"}],"category":"Analytical Databases"},"engine":"clickhousedb","engine_name":"ClickHouse","engine_aliases":[],"default_driver":"connect","supports_file_upload":false,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"clickhouse","engine_name":"ClickHouse","module":"clickhouse","documentation":{"description":"ClickHouse is an open-source column-oriented database for real-time analytics using SQL. It's known for extremely fast query performance on large datasets.","logo":"clickhouse.png","homepage_url":"https://clickhouse.com/","categories":["ANALYTICAL_DATABASES","OPEN_SOURCE"],"pypi_packages":["clickhouse-connect>=0.13.0"],"connection_string":"clickhousedb://{username}:{password}@{host}:{port}/{database}","default_port":8123,"drivers":[{"name":"clickhouse-connect (Recommended)","pypi_package":"clickhouse-connect>=0.13.0","connection_string":"clickhousedb://{username}:{password}@{host}:{port}/{database}","is_recommended":true,"notes":"Official ClickHouse Python driver with native protocol support."},{"name":"clickhouse-sqlalchemy (Legacy)","pypi_package":"clickhouse-sqlalchemy","connection_string":"clickhouse://{username}:{password}@{host}:{port}/{database}","is_recommended":false,"notes":"Older driver using HTTP interface. Use clickhouse-connect for new deployments."}],"connection_examples":[{"description":"Altinity Cloud","connection_string":"clickhousedb://demo:demo@github.demo.trial.altinity.cloud/default?secure=true"},{"description":"Local (no auth, no SSL)","connection_string":"clickhousedb://localhost/default"}],"install_instructions":"echo \"clickhouse-connect>=0.13.0\" >> ./docker/requirements-local.txt","compatible_databases":[{"name":"ClickHouse Cloud","description":"ClickHouse Cloud is the official fully-managed cloud service for ClickHouse. It provides automatic scaling, built-in backups, and enterprise security features.","logo":"clickhouse.png","homepage_url":"https://clickhouse.cloud/","categories":["ANALYTICAL_DATABASES","CLOUD_DATA_WAREHOUSES","HOSTED_OPEN_SOURCE"],"pypi_packages":["clickhouse-connect>=0.13.0"],"connection_string":"clickhousedb://{username}:{password}@{host}:8443/{database}?secure=true","parameters":{"username":"ClickHouse Cloud username","password":"ClickHouse Cloud password","host":"Your ClickHouse Cloud hostname","database":"Database name (default)"},"docs_url":"https://clickhouse.com/docs/en/cloud"},{"name":"Altinity.Cloud","description":"Altinity.Cloud is a managed ClickHouse service providing Kubernetes-native deployments with enterprise support.","logo":"altinity.png","homepage_url":"https://altinity.cloud/","categories":["ANALYTICAL_DATABASES","CLOUD_DATA_WAREHOUSES","HOSTED_OPEN_SOURCE"],"pypi_packages":["clickhouse-connect>=0.13.0"],"connection_string":"clickhousedb://{username}:{password}@{host}/{database}?secure=true","docs_url":"https://docs.altinity.com/"}]},"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":51,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/cloudflare-d1.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/cloudflare-d1.mdx index bf9b4d450df..e56afc68ae4 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/cloudflare-d1.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/cloudflare-d1.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"module":"superset.db_engine_specs.d1","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":true,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":41,"max_score":201,"documentation":{"description":"Cloudflare D1 is a serverless SQLite database.","logo":"cloudflare.png","homepage_url":"https://developers.cloudflare.com/d1/","categories":["Cloud Data Warehouses","Traditional RDBMS","Hosted Open Source"],"pypi_packages":["superset-engine-d1"],"connection_string":"d1://{cloudflare_account_id}:{cloudflare_api_token}@{cloudflare_d1_database_id}","parameters":{"cloudflare_account_id":"Cloudflare account ID","cloudflare_api_token":"Cloudflare API token","cloudflare_d1_database_id":"D1 database ID"},"install_instructions":"pip install superset-engine-d1","category":"Other Databases"},"engine":"d1","engine_name":"Cloudflare D1","engine_aliases":[],"default_driver":"d1","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"cloudflare_d1","engine_name":"Cloudflare D1","module":"d1","documentation":{"description":"Cloudflare D1 is a serverless SQLite database.","logo":"cloudflare.png","homepage_url":"https://developers.cloudflare.com/d1/","pypi_packages":["superset-engine-d1"],"connection_string":"d1://{cloudflare_account_id}:{cloudflare_api_token}@{cloudflare_d1_database_id}","notes":"No additional library needed. SQLite is bundled with Python.","categories":["CLOUD_DATA_WAREHOUSES","TRADITIONAL_RDBMS","HOSTED_OPEN_SOURCE"],"parameters":{"cloudflare_account_id":"Cloudflare account ID","cloudflare_api_token":"Cloudflare API token","cloudflare_d1_database_id":"D1 database ID"},"install_instructions":"pip install superset-engine-d1"},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/cockroachdb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/cockroachdb.mdx index 5fee945bc0c..326ab617e5f 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/cockroachdb.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/cockroachdb.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.cockroachdb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":63,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":true,"sql_validation":false,"score":94,"max_score":201,"documentation":{"description":"CockroachDB is a distributed SQL database built for cloud applications.","logo":"cockroachdb.png","homepage_url":"https://www.cockroachlabs.com/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["cockroachdb"],"connection_string":"cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable","default_port":26257,"docs_url":"https://github.com/cockroachdb/sqlalchemy-cockroachdb","category":"Other Databases"},"engine":"cockroachdb","engine_name":"CockroachDB","engine_aliases":["postgres"],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"cockroachdb","engine_name":"CockroachDB","module":"cockroachdb","documentation":{"description":"CockroachDB is a distributed SQL database built for cloud applications.","logo":"cockroachdb.png","homepage_url":"https://www.cockroachlabs.com/","pypi_packages":["psycopg2","cockroachdb"],"connection_string":"cockroachdb://root@{hostname}:{port}/{database}?sslmode=disable","default_port":26257,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://github.com/cockroachdb/sqlalchemy-cockroachdb","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":94,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":true,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/couchbase.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/couchbase.mdx index 764261b52d5..c3ad603d99a 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/couchbase.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/couchbase.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.couchbase","limit_method":1,"limit_clause":true,"joins":false,"subqueries":false,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":27,"max_score":201,"documentation":{"description":"Couchbase is a distributed NoSQL document database with SQL++ support.","logo":"couchbase.svg","homepage_url":"https://www.couchbase.com/","categories":["Search & NoSQL","Open Source"],"pypi_packages":["couchbase-sqlalchemy"],"connection_string":"couchbase://{username}:{password}@{host}:{port}?ssl=true","default_port":8091,"parameters":{"username":"Couchbase username","password":"Couchbase password","host":"Couchbase host or connection string for cloud","port":"Couchbase port (default 8091)","database":"Couchbase database/bucket name"},"drivers":[{"name":"couchbase-sqlalchemy","pypi_package":"couchbase-sqlalchemy","connection_string":"couchbase://{username}:{password}@{host}:{port}?ssl=true","is_recommended":true}],"category":"Search & NoSQL"},"engine":"couchbase","engine_name":"Couchbase","engine_aliases":["couchbasedb"],"default_driver":"couchbase","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"couchbase","engine_name":"Couchbase","module":"couchbase","documentation":{"description":"Couchbase is a distributed NoSQL document database with SQL++ support.","logo":"couchbase.svg","homepage_url":"https://www.couchbase.com/","categories":["SEARCH_NOSQL","OPEN_SOURCE"],"pypi_packages":["couchbase-sqlalchemy"],"connection_string":"couchbase://{username}:{password}@{host}:{port}?ssl=true","default_port":8091,"parameters":{"username":"Couchbase username","password":"Couchbase password","host":"Couchbase host or connection string for cloud","port":"Couchbase port (default 8091)","database":"Couchbase database/bucket name"},"drivers":[{"name":"couchbase-sqlalchemy","pypi_package":"couchbase-sqlalchemy","connection_string":"couchbase://{username}:{password}@{host}:{port}?ssl=true","is_recommended":true}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":27,"max_score":201,"joins":false,"subqueries":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/cratedb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/cratedb.mdx index 92796e4282a..396741a4d0f 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/cratedb.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/cratedb.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.crate","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"CrateDB is a distributed SQL database for machine data and IoT workloads.","logo":"cratedb.svg","homepage_url":"https://cratedb.com","categories":["Time Series Databases","Open Source"],"pypi_packages":["crate","sqlalchemy-cratedb"],"connection_string":"crate://{host}:{port}","default_port":4200,"parameters":{"host":"CrateDB host","port":"CrateDB HTTP port (default 4200)"},"drivers":[{"name":"crate","pypi_package":"crate[sqlalchemy]","connection_string":"crate://{host}:{port}","is_recommended":true}],"category":"Other Databases"},"engine":"crate","engine_name":"CrateDB","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"cratedb","engine_name":"CrateDB","module":"crate","documentation":{"description":"CrateDB is a distributed SQL database for machine data and IoT workloads.","logo":"cratedb.svg","homepage_url":"https://cratedb.com","categories":["TIME_SERIES","OPEN_SOURCE"],"pypi_packages":["crate","sqlalchemy-cratedb"],"connection_string":"crate://{host}:{port}","default_port":4200,"parameters":{"host":"CrateDB host","port":"CrateDB HTTP port (default 4200)"},"drivers":[{"name":"crate","pypi_package":"crate[sqlalchemy]","connection_string":"crate://{host}:{port}","is_recommended":true}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/databend-legacy.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/databend-legacy.mdx deleted file mode 100644 index 8c143916849..00000000000 --- a/docs/versioned_docs/version-6.1.0/databases/supported/databend-legacy.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Databend (legacy) -sidebar_label: Databend (legacy) -description: "Documentation for Databend (legacy) database connection." -hide_title: true ---- - -{/* -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF 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. -*/} - -import { DatabasePage } from '@site/src/components/databases'; - -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.databend","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":false,"file_upload":false,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":51,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"engine+driver://user:password@host:port/dbname[?key=value&key=value...]","category":"Other Databases"},"engine":"databend","engine_name":"Databend (legacy)","engine_aliases":[],"default_driver":null,"supports_file_upload":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; - - diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/databend.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/databend.mdx index 68aa4f82d83..d246f567e78 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/databend.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/databend.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.databend","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":false,"file_upload":false,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":51,"max_score":201,"documentation":{"description":"Databend is a modern cloud-native data warehouse with instant elasticity and pay-as-you-go pricing. Built in Rust for high performance.","logo":"databend.png","homepage_url":"https://www.databend.com/","categories":["Cloud Data Warehouses","Analytical Databases","Proprietary"],"pypi_packages":["databend-sqlalchemy"],"connection_string":"databend://{username}:{password}@{host}:{port}/{database}?secure=true","default_port":443,"parameters":{"username":"Database username","password":"Database password","host":"Databend host","port":"Databend port (default 443 for HTTPS)","database":"Database name"},"category":"Other Databases"},"engine":"databend","engine_name":"Databend","engine_aliases":[],"default_driver":"databend","supports_file_upload":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"databend","engine_name":"Databend","module":"databend","documentation":{"description":"Databend is a modern cloud-native data warehouse with instant elasticity and pay-as-you-go pricing. Built in Rust for high performance.","logo":"databend.png","homepage_url":"https://www.databend.com/","categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["databend-sqlalchemy"],"connection_string":"databend://{username}:{password}@{host}:{port}/{database}?secure=true","default_port":443,"parameters":{"username":"Database username","password":"Database password","host":"Databend host","port":"Databend port (default 443 for HTTPS)","database":"Database name"}},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":51,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/databricks-interactive-cluster.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/databricks-interactive-cluster.mdx index e70445bcf74..8c70aceb160 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/databricks-interactive-cluster.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/databricks-interactive-cluster.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.databricks","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":false,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":767,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":true,"expand_data":true,"query_cost_estimation":true,"sql_validation":false,"score":140,"max_score":201,"documentation":{"description":"Apache Hive is a data warehouse infrastructure built on Hadoop.","logo":"apache-hive.svg","homepage_url":"https://hive.apache.org/","categories":["Apache Projects","Query Engines","Open Source"],"pypi_packages":["pyhive"],"connection_string":"hive://hive@{hostname}:{port}/{database}","default_port":10000,"category":"Cloud Data Warehouses"},"engine":"databricks","engine_name":"Databricks Interactive Cluster","engine_aliases":[],"default_driver":"pyhive","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"databricks_interactive_cluster","engine_name":"Databricks Interactive Cluster","module":"databricks","documentation":{"description":"Apache Hive is a data warehouse infrastructure built on Hadoop.","logo":"apache-hive.svg","homepage_url":"https://hive.apache.org/","pypi_packages":["pyhive","pyhive"],"install_instructions":"pip install \"apache-superset[presto]\"","connection_string":"hive://hive@{hostname}:{port}/{database}","default_port":10000,"parameters":{"hostname":"Presto coordinator hostname","port":"Presto coordinator port (default 8080)","database":"Catalog name"},"drivers":[{"name":"PyHive","pypi_package":"pyhive","connection_string":"presto://{hostname}:{port}/{database}","is_recommended":true}],"categories":["APACHE_PROJECTS","QUERY_ENGINES","OPEN_SOURCE"]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/databricks-legacy.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/databricks-legacy.mdx deleted file mode 100644 index 940b9c9704e..00000000000 --- a/docs/versioned_docs/version-6.1.0/databases/supported/databricks-legacy.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Databricks (legacy) -sidebar_label: Databricks (legacy) -description: "Documentation for Databricks (legacy) database connection." -hide_title: true ---- - -{/* -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF 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. -*/} - -import { DatabasePage } from '@site/src/components/databases'; - -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.databricks","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":true,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":70,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"databricks+connector://token:{access_token}@{host}:{port}/{database_name}","category":"Cloud Data Warehouses"},"engine":"databricks","engine_name":"Databricks (legacy)","engine_aliases":[],"default_driver":"connector","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; - - diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/databricks-sql-endpoint.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/databricks-sql-endpoint.mdx deleted file mode 100644 index 392ba1453c0..00000000000 --- a/docs/versioned_docs/version-6.1.0/databases/supported/databricks-sql-endpoint.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Databricks SQL Endpoint -sidebar_label: Databricks SQL Endpoint -description: "Documentation for Databricks SQL Endpoint database connection." -hide_title: true ---- - -{/* -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF 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. -*/} - -import { DatabasePage } from '@site/src/components/databases'; - -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.databricks","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":30,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"engine+driver://user:password@host:port/dbname[?key=value&key=value...]","category":"Cloud Data Warehouses"},"engine":"databricks","engine_name":"Databricks SQL Endpoint","engine_aliases":[],"default_driver":"pyodbc","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; - - diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/databricks.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/databricks.mdx index 09540730e6c..abf52c61408 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/databricks.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/databricks.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.databricks","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":true,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":70,"max_score":201,"documentation":{"description":"Databricks is a unified analytics platform built on Apache Spark, providing data engineering, data science, and machine learning capabilities in the cloud. Use the Python Connector for SQL warehouses and clusters.","logo":"databricks.png","homepage_url":"https://www.databricks.com/","categories":["Cloud Data Warehouses","Analytical Databases","Hosted Open Source"],"pypi_packages":["apache-superset[databricks]"],"install_instructions":"pip install apache-superset[databricks]","connection_string":"databricks://token:{access_token}@{host}:{port}?http_path={http_path}&catalog={catalog}&schema={schema}","parameters":{"access_token":"Personal access token from Settings > User Settings","host":"Server hostname from cluster JDBC/ODBC settings","port":"Port (default 443)","http_path":"HTTP path from cluster JDBC/ODBC settings"},"drivers":[{"name":"Databricks Python Connector (Recommended)","pypi_package":"databricks-sql-connector","connection_string":"databricks://token:{access_token}@{host}:{port}?http_path={http_path}&catalog={catalog}&schema={schema}","is_recommended":true,"notes":"Official Databricks connector. Best for SQL warehouses and clusters."},{"name":"Hive Connector (Interactive Clusters)","pypi_package":"databricks-dbapi[sqlalchemy]","connection_string":"databricks+pyhive://token:{access_token}@{host}:{port}/{database}","is_recommended":false,"notes":"For Interactive Clusters. Requires http_path in engine parameters."},{"name":"ODBC (SQL Endpoints)","pypi_package":"pyodbc","connection_string":"databricks+pyodbc://token:{access_token}@{host}:{port}/{database}","is_recommended":false,"notes":"Requires ODBC driver. For serverless SQL warehouses."},{"name":"databricks-dbapi (Legacy)","pypi_package":"databricks-dbapi[sqlalchemy]","connection_string":"databricks+connector://token:{access_token}@{host}:{port}/{database}","is_recommended":false,"notes":"Legacy connector. Use Python Connector for new deployments."}],"category":"Cloud Data Warehouses"},"engine":"databricks","engine_name":"Databricks","engine_aliases":[],"default_driver":"databricks-sql-python","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"databricks","engine_name":"Databricks","module":"databricks","documentation":{"description":"Databricks is a unified analytics platform built on Apache Spark, providing data engineering, data science, and machine learning capabilities in the cloud. Use the Python Connector for SQL warehouses and clusters.","logo":"databricks.png","homepage_url":"https://www.databricks.com/","categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","HOSTED_OPEN_SOURCE"],"pypi_packages":["apache-superset[databricks]"],"install_instructions":"pip install apache-superset[databricks]","connection_string":"databricks://token:{access_token}@{host}:{port}?http_path={http_path}&catalog={catalog}&schema={schema}","parameters":{"access_token":"Personal access token from Settings > User Settings","host":"Server hostname from cluster JDBC/ODBC settings","port":"Port (default 443)","http_path":"HTTP path from cluster JDBC/ODBC settings"},"drivers":[{"name":"Databricks Python Connector (Recommended)","pypi_package":"databricks-sql-connector","connection_string":"databricks://token:{access_token}@{host}:{port}?http_path={http_path}&catalog={catalog}&schema={schema}","is_recommended":true,"notes":"Official Databricks connector. Best for SQL warehouses and clusters."},{"name":"Hive Connector (Interactive Clusters)","pypi_package":"databricks-dbapi[sqlalchemy]","connection_string":"databricks+pyhive://token:{access_token}@{host}:{port}/{database}","is_recommended":false,"notes":"For Interactive Clusters. Requires http_path in engine parameters."},{"name":"ODBC (SQL Endpoints)","pypi_package":"pyodbc","connection_string":"databricks+pyodbc://token:{access_token}@{host}:{port}/{database}","is_recommended":false,"notes":"Requires ODBC driver. For serverless SQL warehouses."},{"name":"databricks-dbapi (Legacy)","pypi_package":"databricks-dbapi[sqlalchemy]","connection_string":"databricks+connector://token:{access_token}@{host}:{port}/{database}","is_recommended":false,"notes":"Legacy connector. Use Python Connector for new deployments."}]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/denodo.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/denodo.mdx index 736cd375f91..cd4f4e1f016 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/denodo.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/denodo.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.denodo","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":27,"max_score":201,"documentation":{"description":"Denodo is a data virtualization platform for logical data management.","logo":"denodo.png","homepage_url":"https://www.denodo.com/","categories":["Query Engines","Proprietary"],"pypi_packages":["psycopg2"],"connection_string":"denodo://{username}:{password}@{host}:{port}/{database}","default_port":9996,"parameters":{"username":"Denodo username","password":"Denodo password","host":"Denodo VDP server hostname","port":"ODBC port (default 9996)","database":"Virtual database name"},"drivers":[{"name":"psycopg2","pypi_package":"psycopg2","connection_string":"denodo://{username}:{password}@{host}:{port}/{database}","is_recommended":true,"notes":"Uses PostgreSQL wire protocol."}],"category":"Other Databases","custom_errors":[{"message_template":"Incorrect username or password.","error_type":"CONNECTION_INVALID_USERNAME_ERROR","category":"Authentication","description":"Invalid username","issue_codes":[1012],"invalid_fields":["username","password"]},{"message_template":"Please enter a password.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["password"]},{"message_template":"Hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"message_template":"Server refused the connection: check hostname and port.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008],"invalid_fields":["host","port"]},{"message_template":"Unable to connect to database \"%(database)s\"","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"message_template":"Unable to connect to database \"%(database)s\": database does not exist or insufficient permissions","error_type":"CONNECTION_DATABASE_PERMISSIONS_ERROR","category":"Permissions","description":"Insufficient permissions","issue_codes":[1017],"invalid_fields":["database"]},{"message_template":"Please check your query for syntax errors at or near \"%(err)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]},{"message_template":"Column \"%(column)s\" not found in \"%(view)s\".","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"message_template":"Invalid aggregation expression.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]},{"message_template":"\"%(exp)s\" is neither an aggregation function nor appears in the GROUP BY clause.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"denodo","engine_name":"Denodo","engine_aliases":[],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"denodo","engine_name":"Denodo","module":"denodo","documentation":{"description":"Denodo is a data virtualization platform for logical data management.","logo":"denodo.png","homepage_url":"https://www.denodo.com/","categories":["QUERY_ENGINES","PROPRIETARY"],"pypi_packages":["psycopg2"],"connection_string":"denodo://{username}:{password}@{host}:{port}/{database}","default_port":9996,"parameters":{"username":"Denodo username","password":"Denodo password","host":"Denodo VDP server hostname","port":"ODBC port (default 9996)","database":"Virtual database name"},"drivers":[{"name":"psycopg2","pypi_package":"psycopg2","connection_string":"denodo://{username}:{password}@{host}:{port}/{database}","is_recommended":true,"notes":"Uses PostgreSQL wire protocol."}],"custom_errors":[{"message_template":"Incorrect username or password.","error_type":"CONNECTION_INVALID_USERNAME_ERROR","category":"Authentication","description":"Invalid username","issue_codes":[1012],"invalid_fields":["username","password"]},{"message_template":"Please enter a password.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["password"]},{"message_template":"Hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"message_template":"Server refused the connection: check hostname and port.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008],"invalid_fields":["host","port"]},{"message_template":"Unable to connect to database \"%(database)s\"","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"message_template":"Unable to connect to database \"%(database)s\": database does not exist or insufficient permissions","error_type":"CONNECTION_DATABASE_PERMISSIONS_ERROR","category":"Permissions","description":"Insufficient permissions","issue_codes":[1017],"invalid_fields":["database"]},{"message_template":"Please check your query for syntax errors at or near \"%(err)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]},{"message_template":"Column \"%(column)s\" not found in \"%(view)s\".","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"message_template":"Invalid aggregation expression.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]},{"message_template":"\"%(exp)s\" is neither an aggregation function nor appears in the GROUP BY clause.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":27,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/dremio.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/dremio.mdx index e3b0545e1b3..f044433aa11 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/dremio.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/dremio.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.dremio","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Dremio is a data lakehouse platform for fast, self-service analytics.","logo":"dremio.png","homepage_url":"https://www.dremio.com/","categories":["Query Engines","Proprietary"],"pypi_packages":["sqlalchemy_dremio"],"connection_string":"dremio+flight://data.dremio.cloud:443/?Token={token}&UseEncryption=true","parameters":{"token":"Personal Access Token (PAT) or API token"},"drivers":[{"name":"Arrow Flight (Recommended)","pypi_package":"sqlalchemy_dremio","connection_string":"dremio+flight://data.dremio.cloud:443/?Token={token}&UseEncryption=true","is_recommended":true},{"name":"ODBC","pypi_package":"sqlalchemy_dremio","connection_string":"dremio+pyodbc://{token}@{host}:31010/dremio","is_recommended":false,"notes":"Requires Dremio ODBC drivers installed."}],"category":"Other Databases"},"engine":"dremio","engine_name":"Dremio","engine_aliases":["dremio+flight"],"default_driver":"flight","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"dremio","engine_name":"Dremio","module":"dremio","documentation":{"description":"Dremio is a data lakehouse platform for fast, self-service analytics.","logo":"dremio.png","homepage_url":"https://www.dremio.com/","categories":["QUERY_ENGINES","PROPRIETARY"],"pypi_packages":["sqlalchemy_dremio"],"connection_string":"dremio+flight://data.dremio.cloud:443/?Token={token}&UseEncryption=true","parameters":{"token":"Personal Access Token (PAT) or API token"},"drivers":[{"name":"Arrow Flight (Recommended)","pypi_package":"sqlalchemy_dremio","connection_string":"dremio+flight://data.dremio.cloud:443/?Token={token}&UseEncryption=true","is_recommended":true},{"name":"ODBC","pypi_package":"sqlalchemy_dremio","connection_string":"dremio+pyodbc://{token}@{host}:31010/dremio","is_recommended":false,"notes":"Requires Dremio ODBC drivers installed."}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/duckdb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/duckdb.mdx index 9cbb6a209d4..4a97319c61d 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/duckdb.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/duckdb.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.duckdb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":38,"max_score":201,"documentation":{"description":"DuckDB is an in-process OLAP database designed for fast analytical queries on local data. Supports CSV, Parquet, JSON, and many other file formats.","logo":"duckdb.png","homepage_url":"https://duckdb.org/","categories":["Analytical Databases","Open Source"],"pypi_packages":["duckdb-engine"],"connection_string":"duckdb:////path/to/duck.db","drivers":[{"name":"duckdb-engine","pypi_package":"duckdb-engine","connection_string":"duckdb:////path/to/duck.db","is_recommended":true}],"notes":"DuckDB supports both local file and in-memory databases. Use `:memory:` for in-memory database.","compatible_databases":[{"name":"MotherDuck","description":"MotherDuck is a serverless cloud analytics platform built on DuckDB, offering collaborative data sharing and cloud-native scalability.","logo":"motherduck.png","homepage_url":"https://motherduck.com/","pypi_packages":["duckdb","duckdb-engine"],"connection_string":"duckdb:///md:{database}?motherduck_token={token}","parameters":{"database":"MotherDuck database name","motherduck_token":"Service token from MotherDuck dashboard"},"notes":"Cloud-hosted DuckDB with collaboration features.","categories":["Hosted Open Source"]}],"category":"Other Databases","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"engine":"duckdb","engine_name":"DuckDB","engine_aliases":[],"default_driver":"duckdb_engine","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"duckdb","engine_name":"DuckDB","module":"duckdb","documentation":{"description":"DuckDB is an in-process OLAP database designed for fast analytical queries on local data. Supports CSV, Parquet, JSON, and many other file formats.","logo":"duckdb.png","homepage_url":"https://duckdb.org/","categories":["ANALYTICAL_DATABASES","OPEN_SOURCE"],"pypi_packages":["duckdb-engine"],"connection_string":"duckdb:////path/to/duck.db","drivers":[{"name":"duckdb-engine","pypi_package":"duckdb-engine","connection_string":"duckdb:////path/to/duck.db","is_recommended":true}],"notes":"DuckDB supports both local file and in-memory databases. Use `:memory:` for in-memory database.","compatible_databases":[{"name":"MotherDuck","description":"MotherDuck is a serverless cloud analytics platform built on DuckDB, offering collaborative data sharing and cloud-native scalability.","logo":"motherduck.png","homepage_url":"https://motherduck.com/","pypi_packages":["duckdb","duckdb-engine"],"connection_string":"duckdb:///md:{database}?motherduck_token={token}","parameters":{"database":"MotherDuck database name","motherduck_token":"Service token from MotherDuck dashboard"},"notes":"Cloud-hosted DuckDB with collaboration features.","categories":["HOSTED_OPEN_SOURCE"]}],"custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":38,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/elasticsearch.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/elasticsearch.mdx index 8f591e04b73..f9269a60438 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/elasticsearch.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/elasticsearch.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.elasticsearch","limit_method":1,"limit_clause":true,"joins":false,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":false,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":37,"max_score":201,"documentation":{"description":"Elasticsearch is a distributed search and analytics engine. Query data using Elasticsearch SQL or OpenSearch SQL syntax.","logo":"elasticsearch.png","homepage_url":"https://www.elastic.co/elasticsearch/","categories":["Search & NoSQL","Open Source"],"pypi_packages":["elasticsearch-dbapi"],"connection_string":"elasticsearch+https://{user}:{password}@{host}:9243/","default_port":9243,"parameters":{"user":"Elasticsearch username","password":"Elasticsearch password","host":"Elasticsearch host"},"drivers":[{"name":"Elasticsearch SQL API (Recommended)","pypi_package":"elasticsearch-dbapi","connection_string":"elasticsearch+https://{user}:{password}@{host}:9243/","is_recommended":true,"notes":"For Elastic Cloud and self-hosted Elasticsearch with SQL enabled."},{"name":"OpenDistro / OpenSearch SQL","pypi_package":"elasticsearch-dbapi","connection_string":"odelasticsearch+https://{user}:{password}@{host}:9200/","is_recommended":false,"notes":"For OpenDistro Elasticsearch or Amazon OpenSearch Service."}],"compatible_databases":[{"name":"Elastic Cloud","description":"Elastic Cloud is the official managed Elasticsearch service from Elastic. It includes Elasticsearch, Kibana, and enterprise features with automatic scaling.","logo":"elasticsearch.png","homepage_url":"https://www.elastic.co/cloud/","categories":["Search & NoSQL","Hosted Open Source"],"pypi_packages":["elasticsearch-dbapi"],"connection_string":"elasticsearch+https://{user}:{password}@{deployment}.{region}.cloud.es.io:9243/","docs_url":"https://www.elastic.co/guide/en/cloud/current/"},{"name":"Amazon OpenSearch Service","description":"Amazon OpenSearch Service (successor to Amazon Elasticsearch Service) is a managed search and analytics service on AWS.","logo":"elasticsearch.png","homepage_url":"https://aws.amazon.com/opensearch-service/","categories":["Search & NoSQL","Cloud - AWS","Hosted Open Source"],"pypi_packages":["elasticsearch-dbapi"],"connection_string":"odelasticsearch+https://{user}:{password}@{host}:443/","docs_url":"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/"}],"category":"Search & NoSQL"},"engine":"elasticsearch","engine_name":"Elasticsearch","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"elasticsearch","engine_name":"Elasticsearch","module":"elasticsearch","documentation":{"description":"Elasticsearch is a distributed search and analytics engine. Query data using Elasticsearch SQL or OpenSearch SQL syntax.","logo":"elasticsearch.png","homepage_url":"https://www.elastic.co/elasticsearch/","categories":["SEARCH_NOSQL","OPEN_SOURCE"],"pypi_packages":["elasticsearch-dbapi"],"connection_string":"elasticsearch+https://{user}:{password}@{host}:9243/","default_port":9243,"parameters":{"user":"Elasticsearch username","password":"Elasticsearch password","host":"Elasticsearch host"},"drivers":[{"name":"Elasticsearch SQL API (Recommended)","pypi_package":"elasticsearch-dbapi","connection_string":"elasticsearch+https://{user}:{password}@{host}:9243/","is_recommended":true,"notes":"For Elastic Cloud and self-hosted Elasticsearch with SQL enabled."},{"name":"OpenDistro / OpenSearch SQL","pypi_package":"elasticsearch-dbapi","connection_string":"odelasticsearch+https://{user}:{password}@{host}:9200/","is_recommended":false,"notes":"For OpenDistro Elasticsearch or Amazon OpenSearch Service."}],"compatible_databases":[{"name":"Elastic Cloud","description":"Elastic Cloud is the official managed Elasticsearch service from Elastic. It includes Elasticsearch, Kibana, and enterprise features with automatic scaling.","logo":"elasticsearch.png","homepage_url":"https://www.elastic.co/cloud/","categories":["SEARCH_NOSQL","HOSTED_OPEN_SOURCE"],"pypi_packages":["elasticsearch-dbapi"],"connection_string":"elasticsearch+https://{user}:{password}@{deployment}.{region}.cloud.es.io:9243/","docs_url":"https://www.elastic.co/guide/en/cloud/current/"},{"name":"Amazon OpenSearch Service","description":"Amazon OpenSearch Service (successor to Amazon Elasticsearch Service) is a managed search and analytics service on AWS.","logo":"elasticsearch.png","homepage_url":"https://aws.amazon.com/opensearch-service/","categories":["SEARCH_NOSQL","CLOUD_AWS","HOSTED_OPEN_SOURCE"],"pypi_packages":["elasticsearch-dbapi"],"connection_string":"odelasticsearch+https://{user}:{password}@{host}:443/","docs_url":"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/"}]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/exasol.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/exasol.mdx index 273bdc1fce2..a56a2ce9d84 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/exasol.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/exasol.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.exasol","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Exasol is a high-performance, in-memory, MPP analytical database.","logo":"exasol.png","homepage_url":"https://www.exasol.com/","categories":["Analytical Databases","Proprietary"],"pypi_packages":["sqlalchemy-exasol"],"connection_string":"exa+pyodbc://{username}:{password}@{dsn}","default_port":8563,"parameters":{"username":"Database username","password":"Database password","dsn":"DSN name configured in odbc.ini"},"drivers":[{"name":"pyodbc","pypi_package":"sqlalchemy-exasol","connection_string":"exa+pyodbc://{username}:{password}@{dsn}","is_recommended":true,"notes":"Requires ODBC driver and DSN configuration."},{"name":"turbodbc","pypi_package":"sqlalchemy-exasol[turbodbc]","connection_string":"exa+turbodbc://{username}:{password}@{dsn}","is_recommended":false,"notes":"Faster but requires additional dependencies."},{"name":"websocket","pypi_package":"sqlalchemy-exasol[websocket]","connection_string":"exa+websocket://{username}:{password}@{host}:{port}/{schema}","is_recommended":false,"notes":"Pure Python, no ODBC required."}],"category":"Other Databases"},"engine":"exa","engine_name":"Exasol","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"exasol","engine_name":"Exasol","module":"exasol","documentation":{"description":"Exasol is a high-performance, in-memory, MPP analytical database.","logo":"exasol.png","homepage_url":"https://www.exasol.com/","categories":["ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["sqlalchemy-exasol"],"connection_string":"exa+pyodbc://{username}:{password}@{dsn}","default_port":8563,"parameters":{"username":"Database username","password":"Database password","dsn":"DSN name configured in odbc.ini"},"drivers":[{"name":"pyodbc","pypi_package":"sqlalchemy-exasol","connection_string":"exa+pyodbc://{username}:{password}@{dsn}","is_recommended":true,"notes":"Requires ODBC driver and DSN configuration."},{"name":"turbodbc","pypi_package":"sqlalchemy-exasol[turbodbc]","connection_string":"exa+turbodbc://{username}:{password}@{dsn}","is_recommended":false,"notes":"Faster but requires additional dependencies."},{"name":"websocket","pypi_package":"sqlalchemy-exasol[websocket]","connection_string":"exa+websocket://{username}:{password}@{host}:{port}/{schema}","is_recommended":false,"notes":"Pure Python, no ODBC required."}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/firebird.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/firebird.mdx index 0ad0a5e194a..dbd61ed5458 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/firebird.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/firebird.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.firebird","limit_method":3,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":26,"max_score":201,"documentation":{"description":"Firebird is an open-source relational database.","logo":"firebird.png","homepage_url":"https://firebirdsql.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["sqlalchemy-firebird"],"version_requirements":"sqlalchemy-firebird>=0.7.0,<0.8","connection_string":"firebird+fdb://{username}:{password}@{host}:{port}//{path_to_db_file}","default_port":3050,"connection_examples":[{"description":"Local database","connection_string":"firebird+fdb://SYSDBA:masterkey@192.168.86.38:3050//Library/Frameworks/Firebird.framework/Versions/A/Resources/examples/empbuild/employee.fdb"}],"category":"Other Databases"},"engine":"firebird","engine_name":"Firebird","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"firebird","engine_name":"Firebird","module":"firebird","documentation":{"description":"Firebird is an open-source relational database.","logo":"firebird.png","homepage_url":"https://firebirdsql.org/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["sqlalchemy-firebird"],"version_requirements":"sqlalchemy-firebird>=0.7.0,<0.8","connection_string":"firebird+fdb://{username}:{password}@{host}:{port}//{path_to_db_file}","default_port":3050,"connection_examples":[{"description":"Local database","connection_string":"firebird+fdb://SYSDBA:masterkey@192.168.86.38:3050//Library/Frameworks/Firebird.framework/Versions/A/Resources/examples/empbuild/employee.fdb"}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"score":26,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/firebolt.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/firebolt.mdx index 1e5f08d3243..c6fe3b3f271 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/firebolt.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/firebolt.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.firebolt","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Firebolt is a cloud data warehouse designed for high-performance analytics.","logo":"firebolt.png","homepage_url":"https://www.firebolt.io/","categories":["Cloud Data Warehouses","Analytical Databases","Proprietary"],"pypi_packages":["firebolt-sqlalchemy"],"connection_string":"firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={account_name}","parameters":{"client_id":"Service account client ID","client_secret":"Service account client secret","database":"Database name","engine_name":"Engine name","account_name":"Account name"},"drivers":[{"name":"firebolt-sqlalchemy","pypi_package":"firebolt-sqlalchemy","connection_string":"firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={account_name}","is_recommended":true}],"category":"Other Databases"},"engine":"firebolt","engine_name":"Firebolt","engine_aliases":[],"default_driver":"firebolt","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"firebolt","engine_name":"Firebolt","module":"firebolt","documentation":{"description":"Firebolt is a cloud data warehouse designed for high-performance analytics.","logo":"firebolt.png","homepage_url":"https://www.firebolt.io/","categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["firebolt-sqlalchemy"],"connection_string":"firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={account_name}","parameters":{"client_id":"Service account client ID","client_secret":"Service account client secret","database":"Database name","engine_name":"Engine name","account_name":"Account name"},"drivers":[{"name":"firebolt-sqlalchemy","pypi_package":"firebolt-sqlalchemy","connection_string":"firebolt://{client_id}:{client_secret}@{database}/{engine_name}?account_name={account_name}","is_recommended":true}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/google-bigquery.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/google-bigquery.mdx index ad4eecce9f0..8938b226fb0 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/google-bigquery.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/google-bigquery.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.bigquery","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":true,"cte_in_subquery":true,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":false,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":true,"expand_data":false,"query_cost_estimation":true,"sql_validation":false,"score":83,"max_score":201,"documentation":{"description":"Google BigQuery is a serverless, highly scalable data warehouse.","logo":"google-big-query.svg","homepage_url":"https://cloud.google.com/bigquery/","categories":["Cloud - Google","Analytical Databases","Proprietary"],"pypi_packages":["sqlalchemy-bigquery"],"connection_string":"bigquery://{project_id}","install_instructions":"echo \"sqlalchemy-bigquery\" >> ./docker/requirements-local.txt","authentication_methods":[{"name":"Service Account JSON","description":"Upload service account credentials JSON or paste in Secure Extra","secure_extra":{"credentials_info":{"type":"service_account","project_id":"...","private_key_id":"...","private_key":"...","client_email":"...","client_id":"...","auth_uri":"...","token_uri":"..."}}}],"notes":"Create a Service Account via GCP console with access to BigQuery datasets. For CSV/Excel uploads, also install pandas_gbq.","warnings":["Google BigQuery Python SDK is not compatible with gevent. Use a worker type other than gevent when deploying with gunicorn."],"docs_url":"https://github.com/googleapis/python-bigquery-sqlalchemy","category":"Cloud - Google","custom_errors":[{"regex_name":"CONNECTION_DATABASE_PERMISSIONS_REGEX","message_template":"Unable to connect. Verify that the following roles are set on the service account: \"BigQuery Data Viewer\", \"BigQuery Metadata Viewer\", \"BigQuery Job User\" and the following permissions are set \"bigquery.readsessions.create\", \"bigquery.readsessions.getData\"","error_type":"CONNECTION_DATABASE_PERMISSIONS_ERROR","category":"Permissions","description":"Insufficient permissions","issue_codes":[1017]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve column \"%(column)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"bigquery","engine_name":"Google BigQuery","engine_aliases":[],"default_driver":"bigquery","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"google_bigquery","engine_name":"Google BigQuery","module":"bigquery","documentation":{"description":"Google BigQuery is a serverless, highly scalable data warehouse.","logo":"google-big-query.svg","homepage_url":"https://cloud.google.com/bigquery/","categories":["CLOUD_GCP","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["sqlalchemy-bigquery"],"connection_string":"bigquery://{project_id}","install_instructions":"echo \"sqlalchemy-bigquery\" >> ./docker/requirements-local.txt","authentication_methods":[{"name":"Service Account JSON","description":"Upload service account credentials JSON or paste in Secure Extra","secure_extra":{"credentials_info":{"type":"service_account","project_id":"...","private_key_id":"...","private_key":"...","client_email":"...","client_id":"...","auth_uri":"...","token_uri":"..."}}}],"notes":"Create a Service Account via GCP console with access to BigQuery datasets. For CSV/Excel uploads, also install pandas_gbq.","warnings":["Google BigQuery Python SDK is not compatible with gevent. Use a worker type other than gevent when deploying with gunicorn."],"docs_url":"https://github.com/googleapis/python-bigquery-sqlalchemy","custom_errors":[{"regex_name":"CONNECTION_DATABASE_PERMISSIONS_REGEX","message_template":"Unable to connect. Verify that the following roles are set on the service account: \"BigQuery Data Viewer\", \"BigQuery Metadata Viewer\", \"BigQuery Job User\" and the following permissions are set \"bigquery.readsessions.create\", \"bigquery.readsessions.getData\"","error_type":"CONNECTION_DATABASE_PERMISSIONS_ERROR","category":"Permissions","description":"Insufficient permissions","issue_codes":[1017]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve column \"%(column)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/google-datastore.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/google-datastore.mdx index 1027dd9ccd2..8246545d0a7 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/google-datastore.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/google-datastore.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.datastore","limit_method":3,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":true,"cte_in_subquery":true,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":true,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":73,"max_score":201,"documentation":{"description":"Google Cloud Datastore is a highly scalable NoSQL database for your applications.","logo":"datastore.png","homepage_url":"https://cloud.google.com/datastore/","categories":["Cloud - Google","Search & NoSQL","Proprietary"],"pypi_packages":["python-datastore-sqlalchemy"],"connection_string":"datastore://{project_id}/?database={database_id}","authentication_methods":[{"name":"Service Account JSON","description":"Upload service account credentials JSON or paste in Secure Extra","secure_extra":{"credentials_info":{"type":"service_account","project_id":"...","private_key_id":"...","private_key":"...","client_email":"...","client_id":"...","auth_uri":"...","token_uri":"..."}}}],"notes":"Create a Service Account via GCP console with access to datastore datasets.","docs_url":"https://github.com/splasky/Python-datastore-sqlalchemy","category":"Cloud - Google","custom_errors":[{"regex_name":"CONNECTION_DATABASE_PERMISSIONS_REGEX","message_template":"Unable to connect. Verify that the following roles are set on the service account: \"Cloud Datastore Viewer\", \"Cloud Datastore User\", \"Cloud Datastore Creator\"","error_type":"CONNECTION_DATABASE_PERMISSIONS_ERROR","category":"Permissions","description":"Insufficient permissions","issue_codes":[1017]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve column \"%(column)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"datastore","engine_name":"Google Datastore","engine_aliases":[],"default_driver":"datastore","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"google_datastore","engine_name":"Google Datastore","module":"datastore","documentation":{"description":"Google Cloud Datastore is a highly scalable NoSQL database for your applications.","logo":"datastore.png","homepage_url":"https://cloud.google.com/datastore/","categories":["CLOUD_GCP","SEARCH_NOSQL","PROPRIETARY"],"pypi_packages":["python-datastore-sqlalchemy"],"connection_string":"datastore://{project_id}/?database={database_id}","authentication_methods":[{"name":"Service Account JSON","description":"Upload service account credentials JSON or paste in Secure Extra","secure_extra":{"credentials_info":{"type":"service_account","project_id":"...","private_key_id":"...","private_key":"...","client_email":"...","client_id":"...","auth_uri":"...","token_uri":"..."}}}],"notes":"Create a Service Account via GCP console with access to datastore datasets.","docs_url":"https://github.com/splasky/Python-datastore-sqlalchemy","custom_errors":[{"regex_name":"CONNECTION_DATABASE_PERMISSIONS_REGEX","message_template":"Unable to connect. Verify that the following roles are set on the service account: \"Cloud Datastore Viewer\", \"Cloud Datastore User\", \"Cloud Datastore Creator\"","error_type":"CONNECTION_DATABASE_PERMISSIONS_ERROR","category":"Permissions","description":"Insufficient permissions","issue_codes":[1017]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve column \"%(column)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/google-sheets.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/google-sheets.mdx index e34ef97bb45..5a6ef6d8ac6 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/google-sheets.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/google-sheets.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"module":"superset.db_engine_specs.gsheets","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":true,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":61,"max_score":201,"documentation":{"description":"Google Sheets allows querying spreadsheets as SQL tables via shillelagh.","logo":"google-sheets.svg","homepage_url":"https://www.google.com/sheets/about/","categories":["Cloud - Google","Hosted Open Source"],"pypi_packages":["shillelagh[gsheetsapi]"],"install_instructions":"pip install \"apache-superset[gsheets]\"","connection_string":"gsheets://","notes":"Requires Google service account credentials or OAuth2 authentication. See docs for setup instructions.","category":"Cloud - Google","custom_errors":[{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"gsheets","engine_name":"Google Sheets","engine_aliases":[],"default_driver":"apsw","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"google_sheets","engine_name":"Google Sheets","module":"gsheets","documentation":{"description":"Google Sheets allows querying spreadsheets as SQL tables via shillelagh.","logo":"google-sheets.svg","homepage_url":"https://www.google.com/sheets/about/","pypi_packages":["shillelagh[gsheetsapi]","shillelagh[gsheetsapi]"],"connection_string":"gsheets://","notes":"Requires Google service account credentials or OAuth2 authentication. See docs for setup instructions.","categories":["CLOUD_GCP","HOSTED_OPEN_SOURCE"],"install_instructions":"pip install \"apache-superset[gsheets]\"","custom_errors":[{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"score":61,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":true,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/greenplum.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/greenplum.mdx index 2c24c1dfdbe..c93e16f107d 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/greenplum.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/greenplum.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.greenplum","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":63,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":true,"sql_validation":false,"score":94,"max_score":201,"documentation":{"description":"VMware Greenplum is a massively parallel processing (MPP) database built on PostgreSQL.","logo":"greenplum.png","homepage_url":"https://greenplum.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["sqlalchemy-greenplum","psycopg2"],"connection_string":"greenplum://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"Greenplum coordinator host","port":"Default 5432","database":"Database name"},"docs_url":"https://docs.vmware.com/en/VMware-Greenplum/","category":"Other Databases"},"engine":"greenplum","engine_name":"Greenplum","engine_aliases":["postgres"],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"greenplum","engine_name":"Greenplum","module":"greenplum","documentation":{"description":"VMware Greenplum is a massively parallel processing (MPP) database built on PostgreSQL.","logo":"greenplum.png","homepage_url":"https://greenplum.org/","pypi_packages":["psycopg2","sqlalchemy-greenplum","psycopg2"],"connection_string":"greenplum://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"Greenplum coordinator host","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://docs.vmware.com/en/VMware-Greenplum/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/hologres.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/hologres.mdx index 158fc5fdac3..94364e6ca79 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/hologres.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/hologres.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.hologres","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":34,"max_score":201,"documentation":{"description":"Alibaba Cloud Hologres is a real-time interactive analytics service, fully compatible with PostgreSQL 11.","logo":"hologres.png","homepage_url":"https://www.alibabacloud.com/product/hologres","categories":["Cloud Data Warehouses","Analytical Databases","Proprietary"],"pypi_packages":["psycopg2"],"connection_string":"postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"AccessKey ID of your Alibaba Cloud account","password":"AccessKey secret of your Alibaba Cloud account","host":"Public endpoint of the Hologres instance","port":"Port number of the Hologres instance","database":"Name of the Hologres database"},"default_port":80,"notes":"Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.","category":"Other Databases"},"engine":"hologres","engine_name":"Hologres","engine_aliases":[],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"hologres","engine_name":"Hologres","module":"hologres","documentation":{"description":"Alibaba Cloud Hologres is a real-time interactive analytics service, fully compatible with PostgreSQL 11.","logo":"hologres.png","homepage_url":"https://www.alibabacloud.com/product/hologres","categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["psycopg2"],"connection_string":"postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"AccessKey ID of your Alibaba Cloud account","password":"AccessKey secret of your Alibaba Cloud account","host":"Public endpoint of the Hologres instance","port":"Port number of the Hologres instance","database":"Name of the Hologres database"},"default_port":80,"notes":"Uses the PostgreSQL driver. psycopg2 comes bundled with Superset."},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2-for-i.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2-for-i.mdx index 25fbbe29998..16767396f74 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2-for-i.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2-for-i.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.ibmi","limit_method":2,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":38,"max_score":201,"documentation":{"description":"IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/db2","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["ibm_db_sa"],"connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","default_port":50000,"drivers":[{"name":"ibm_db_sa (with LIMIT)","connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","is_recommended":true},{"name":"ibm_db_sa (without LIMIT syntax)","connection_string":"ibm_db_sa://{username}:{password}@{hostname}:{port}/{database}","is_recommended":false,"notes":"Use for older DB2 versions without LIMIT [n] syntax. Recommended for SQL Lab."}],"compatible_databases":[{"name":"IBM Db2 for i (AS/400)","description":"Db2 for i is a fully integrated database engine on IBM i (AS/400) systems. Uses a different SQLAlchemy driver optimized for IBM i.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/products/db2-for-i","pypi_packages":["sqlalchemy-ibmi"],"connection_string":"ibmi://{username}:{password}@{host}/{database}","parameters":{"username":"IBM i username","password":"IBM i password","host":"IBM i system host","database":"Library/schema name"},"docs_url":"https://github.com/IBM/sqlalchemy-ibmi","categories":["Proprietary"]}],"docs_url":"https://github.com/ibmdb/python-ibmdbsa","category":"Other Databases"},"engine":"ibmi","engine_name":"IBM Db2 for i","engine_aliases":["ibm_db_sa"],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"ibm_db2_for_i","engine_name":"IBM Db2 for i","module":"ibmi","documentation":{"description":"IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/db2","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["ibm_db_sa"],"connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","default_port":50000,"drivers":[{"name":"ibm_db_sa (with LIMIT)","connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","is_recommended":true},{"name":"ibm_db_sa (without LIMIT syntax)","connection_string":"ibm_db_sa://{username}:{password}@{hostname}:{port}/{database}","is_recommended":false,"notes":"Use for older DB2 versions without LIMIT [n] syntax. Recommended for SQL Lab."}],"docs_url":"https://github.com/ibmdb/python-ibmdbsa"},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2.mdx index a9974a35d57..147dad9cba3 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/ibm-db2.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.db2","limit_method":2,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":30,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":38,"max_score":201,"documentation":{"description":"IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/db2","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["ibm_db_sa"],"connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","default_port":50000,"drivers":[{"name":"ibm_db_sa (with LIMIT)","connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","is_recommended":true},{"name":"ibm_db_sa (without LIMIT syntax)","connection_string":"ibm_db_sa://{username}:{password}@{hostname}:{port}/{database}","is_recommended":false,"notes":"Use for older DB2 versions without LIMIT [n] syntax. Recommended for SQL Lab."}],"compatible_databases":[{"name":"IBM Db2 for i (AS/400)","description":"Db2 for i is a fully integrated database engine on IBM i (AS/400) systems. Uses a different SQLAlchemy driver optimized for IBM i.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/products/db2-for-i","pypi_packages":["sqlalchemy-ibmi"],"connection_string":"ibmi://{username}:{password}@{host}/{database}","parameters":{"username":"IBM i username","password":"IBM i password","host":"IBM i system host","database":"Library/schema name"},"docs_url":"https://github.com/IBM/sqlalchemy-ibmi","categories":["Proprietary"]}],"docs_url":"https://github.com/ibmdb/python-ibmdbsa","category":"Other Databases"},"engine":"db2","engine_name":"IBM Db2","engine_aliases":["ibm_db_sa"],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"ibm_db2","engine_name":"IBM Db2","module":"db2","documentation":{"description":"IBM Db2 is a family of data management products for enterprise workloads, available on-premises, in containers, and across cloud platforms.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/db2","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["ibm_db_sa"],"connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","default_port":50000,"drivers":[{"name":"ibm_db_sa (with LIMIT)","connection_string":"db2+ibm_db://{username}:{password}@{hostname}:{port}/{database}","is_recommended":true},{"name":"ibm_db_sa (without LIMIT syntax)","connection_string":"ibm_db_sa://{username}:{password}@{hostname}:{port}/{database}","is_recommended":false,"notes":"Use for older DB2 versions without LIMIT [n] syntax. Recommended for SQL Lab."}],"compatible_databases":[{"name":"IBM Db2 for i (AS/400)","description":"Db2 for i is a fully integrated database engine on IBM i (AS/400) systems. Uses a different SQLAlchemy driver optimized for IBM i.","logo":"ibm-db2.svg","homepage_url":"https://www.ibm.com/products/db2-for-i","pypi_packages":["sqlalchemy-ibmi"],"connection_string":"ibmi://{username}:{password}@{host}/{database}","parameters":{"username":"IBM i username","password":"IBM i password","host":"IBM i system host","database":"Library/schema name"},"docs_url":"https://github.com/IBM/sqlalchemy-ibmi","categories":["PROPRIETARY"]}],"docs_url":"https://github.com/ibmdb/python-ibmdbsa"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":38,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/ibm-netezza-performance-server.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/ibm-netezza-performance-server.mdx index 4e3c561313a..c40d9281195 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/ibm-netezza-performance-server.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/ibm-netezza-performance-server.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.netezza","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"IBM Netezza Performance Server is a data warehouse appliance.","logo":"netezza.png","homepage_url":"https://www.ibm.com/products/netezza","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["nzalchemy"],"connection_string":"netezza+nzpy://{username}:{password}@{hostname}:{port}/{database}","default_port":5480,"category":"Other Databases"},"engine":"netezza","engine_name":"IBM Netezza Performance Server","engine_aliases":[],"default_driver":"nzpy","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"ibm_netezza_performance_server","engine_name":"IBM Netezza Performance Server","module":"netezza","documentation":{"description":"IBM Netezza Performance Server is a data warehouse appliance.","logo":"netezza.png","homepage_url":"https://www.ibm.com/products/netezza","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["nzalchemy"],"connection_string":"netezza+nzpy://{username}:{password}@{hostname}:{port}/{database}","default_port":5480},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/mariadb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/mariadb.mdx index 1638d663180..6d233006acf 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/mariadb.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/mariadb.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.mariadb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":59,"max_score":201,"documentation":{"description":"MariaDB is a community-developed fork of MySQL.","logo":"mariadb.png","homepage_url":"https://mariadb.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"notes":"Uses the MySQL driver. Fully compatible with MySQL connector.","category":"Traditional RDBMS"},"engine":"mariadb","engine_name":"MariaDB","engine_aliases":[],"default_driver":"mysqldb","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"mariadb","engine_name":"MariaDB","module":"mariadb","documentation":{"description":"MariaDB is a community-developed fork of MySQL.","logo":"mariadb.png","homepage_url":"https://mariadb.org/","pypi_packages":["mysqlclient","mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"notes":"Uses the MySQL driver. Fully compatible with MySQL connector."},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":59,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/microsoft-sql-server.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/microsoft-sql-server.mdx index 5b91b3c3c66..1f84e463b47 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/microsoft-sql-server.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/microsoft-sql-server.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.mssql","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":false,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":44,"max_score":201,"documentation":{"description":"Microsoft SQL Server is a relational database management system.","logo":"msql.png","homepage_url":"https://www.microsoft.com/en-us/sql-server","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["pymssql"],"connection_string":"mssql+pymssql://{username}:{password}@{host}:{port}/{database}","default_port":1433,"drivers":[{"name":"pymssql","pypi_package":"pymssql","connection_string":"mssql+pymssql://{username}:{password}@{host}:{port}/{database}","is_recommended":true},{"name":"pyodbc","pypi_package":"pyodbc","connection_string":"mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3C{host}%3E%2C1433%3BDatabase%3D{database}%3BUid%3D{username}%3BPwd%3D{password}%3BEncrypt%3Dyes%3BConnection+Timeout%3D30","is_recommended":false,"notes":"Connection string must be URL-encoded. Special characters like @ need encoding."}],"docs_url":"https://docs.sqlalchemy.org/en/20/core/engines.html#escaping-special-characters-such-as-signs-in-passwords","category":"Cloud - Azure","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\", password, or database name \"%(database)s\" is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]}]},"engine":"mssql","engine_name":"Microsoft SQL Server","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"microsoft_sql_server","engine_name":"Microsoft SQL Server","module":"mssql","documentation":{"description":"Microsoft SQL Server is a relational database management system.","logo":"msql.png","homepage_url":"https://www.microsoft.com/en-us/sql-server","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["pymssql"],"connection_string":"mssql+pymssql://{username}:{password}@{host}:{port}/{database}","default_port":1433,"drivers":[{"name":"pymssql","pypi_package":"pymssql","connection_string":"mssql+pymssql://{username}:{password}@{host}:{port}/{database}","is_recommended":true},{"name":"pyodbc","pypi_package":"pyodbc","connection_string":"mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3C{host}%3E%2C1433%3BDatabase%3D{database}%3BUid%3D{username}%3BPwd%3D{password}%3BEncrypt%3Dyes%3BConnection+Timeout%3D30","is_recommended":false,"notes":"Connection string must be URL-encoded. Special characters like @ need encoding."}],"docs_url":"https://docs.sqlalchemy.org/en/20/core/engines.html#escaping-special-characters-such-as-signs-in-passwords","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\", password, or database name \"%(database)s\" is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":44,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/monetdb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/monetdb.mdx index 96ec45a1237..6a31409884e 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/monetdb.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/monetdb.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.monetdb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":26,"max_score":201,"documentation":{"description":"MonetDB is an open-source column-oriented relational database for high-performance analytics.","logo":"monet-db.png","homepage_url":"https://www.monetdb.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["sqlalchemy-monetdb","pymonetdb"],"connection_string":"monetdb://{username}:{password}@{host}:{port}/{database}","default_port":50000,"parameters":{"username":"Database username (default: monetdb)","password":"Database password (default: monetdb)","host":"MonetDB server host","port":"Default 50000","database":"Database name"},"docs_url":"https://www.monetdb.org/documentation/","category":"Other Databases"},"engine":"monetdb","engine_name":"MonetDB","engine_aliases":[],"default_driver":"pymonetdb","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"monetdb","engine_name":"MonetDB","module":"monetdb","documentation":{"description":"MonetDB is an open-source column-oriented relational database for high-performance analytics.","logo":"monet-db.png","homepage_url":"https://www.monetdb.org/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["sqlalchemy-monetdb","pymonetdb"],"connection_string":"monetdb://{username}:{password}@{host}:{port}/{database}","default_port":50000,"parameters":{"username":"Database username (default: monetdb)","password":"Database password (default: monetdb)","host":"MonetDB server host","port":"Default 50000","database":"Database name"},"docs_url":"https://www.monetdb.org/documentation/"},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/mongodb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/mongodb.mdx index 43cd0747e5e..c10ff822b94 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/mongodb.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/mongodb.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.mongodb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":32,"max_score":201,"documentation":{"description":"MongoDB is a document-oriented, operational NoSQL database.","logo":"mongodb.png","homepage_url":"https://www.mongodb.com/","categories":["Search & NoSQL","Proprietary"],"pypi_packages":["pymongosql"],"connection_string":"mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset","parameters":{"username":"Username for MongoDB","password":"Password for MongoDB","host":"MongoDB host","port":"MongoDB port","database":"Database name"},"drivers":[{"name":"MongoDB Atlas Cloud","pypi_package":"pymongosql","connection_string":"mongodb+srv://{username}:{password}@{host}/{database}?mode=superset","notes":"For MongoDB Atlas cloud service.","is_recommended":true},{"name":"MongoDB Cluster","pypi_package":"pymongosql","connection_string":"mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset","is_recommended":false,"notes":"For self-hosted MongoDB instances."}],"notes":"Uses PartiQL for SQL queries. Requires mode=superset parameter.","docs_url":"https://github.com/passren/PyMongoSQL","category":"Other Databases"},"engine":"mongodb","engine_name":"MongoDB","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"mongodb","engine_name":"MongoDB","module":"mongodb","documentation":{"description":"MongoDB is a document-oriented, operational NoSQL database.","logo":"mongodb.png","homepage_url":"https://www.mongodb.com/","categories":["SEARCH_NOSQL","PROPRIETARY"],"pypi_packages":["pymongosql"],"connection_string":"mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset","parameters":{"username":"Username for MongoDB","password":"Password for MongoDB","host":"MongoDB host","port":"MongoDB port","database":"Database name"},"drivers":[{"name":"MongoDB Atlas Cloud","pypi_package":"pymongosql","connection_string":"mongodb+srv://{username}:{password}@{host}/{database}?mode=superset","notes":"For MongoDB Atlas cloud service.","is_recommended":true},{"name":"MongoDB Cluster","pypi_package":"pymongosql","connection_string":"mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset","is_recommended":false,"notes":"For self-hosted MongoDB instances."}],"notes":"Uses PartiQL for SQL queries. Requires mode=superset parameter.","docs_url":"https://github.com/passren/PyMongoSQL"},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/motherduck.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/motherduck.mdx index b870c8306c3..96cde59052b 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/motherduck.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/motherduck.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.duckdb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":58,"max_score":201,"documentation":{"description":"MotherDuck is a serverless cloud analytics platform built on DuckDB. It combines the simplicity of DuckDB with cloud-scale data sharing and collaboration.","logo":"motherduck.png","homepage_url":"https://motherduck.com/","categories":["Analytical Databases","Cloud Data Warehouses","Hosted Open Source"],"pypi_packages":["duckdb","duckdb-engine"],"connection_string":"duckdb:///md:{database}?motherduck_token={token}","parameters":{"database":"MotherDuck database name","token":"Service token from MotherDuck dashboard"},"docs_url":"https://motherduck.com/docs/getting-started/","drivers":[{"name":"duckdb-engine","pypi_package":"duckdb-engine","connection_string":"duckdb:///md:{database}?motherduck_token={token}","is_recommended":true}],"category":"Other Databases","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"engine":"motherduck","engine_name":"MotherDuck","engine_aliases":["duckdb"],"default_driver":"duckdb_engine","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"motherduck","engine_name":"MotherDuck","module":"duckdb","documentation":{"description":"MotherDuck is a serverless cloud analytics platform built on DuckDB. It combines the simplicity of DuckDB with cloud-scale data sharing and collaboration.","logo":"motherduck.png","homepage_url":"https://motherduck.com/","pypi_packages":["duckdb-engine","duckdb","duckdb-engine"],"connection_string":"duckdb:///md:{database}?motherduck_token={token}","drivers":[{"name":"duckdb-engine","pypi_package":"duckdb-engine","connection_string":"duckdb:////path/to/duck.db","is_recommended":true},{"name":"duckdb-engine","pypi_package":"duckdb-engine","connection_string":"duckdb:///md:{database}?motherduck_token={token}","is_recommended":true}],"notes":"DuckDB supports both local file and in-memory databases. Use `:memory:` for in-memory database.","categories":["ANALYTICAL_DATABASES","CLOUD_DATA_WAREHOUSES","HOSTED_OPEN_SOURCE"],"parameters":{"database":"MotherDuck database name","token":"Service token from MotherDuck dashboard"},"docs_url":"https://motherduck.com/docs/getting-started/","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/mysql.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/mysql.mdx index b4d904f7b04..a1c00c6679c 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/mysql.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/mysql.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.mysql","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":59,"max_score":201,"documentation":{"description":"MySQL is a popular open-source relational database.","logo":"mysql.png","homepage_url":"https://www.mysql.com/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"compatible_databases":[{"name":"MariaDB","description":"MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.","logo":"mariadb.png","homepage_url":"https://mariadb.org/","pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}:{port}/{database}","categories":["Open Source"]},{"name":"Amazon Aurora MySQL","description":"Amazon Aurora MySQL is a fully managed, MySQL-compatible relational database with up to 5x the throughput of standard MySQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"mysql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard MySQL connections also work with mysqlclient.","categories":["Cloud - AWS","Hosted Open Source"]}],"category":"Traditional RDBMS","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Unknown MySQL server host \"%(hostname)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down and can't be reached.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"mysql","engine_name":"MySQL","engine_aliases":[],"default_driver":"mysqldb","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"mysql","engine_name":"MySQL","module":"mysql","documentation":{"description":"MySQL is a popular open-source relational database.","logo":"mysql.png","homepage_url":"https://www.mysql.com/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"compatible_databases":[{"name":"MariaDB","description":"MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.","logo":"mariadb.png","homepage_url":"https://mariadb.org/","pypi_packages":["mysqlclient"],"connection_string":"mysql://{username}:{password}@{host}:{port}/{database}","categories":["OPEN_SOURCE"]},{"name":"Amazon Aurora MySQL","description":"Amazon Aurora MySQL is a fully managed, MySQL-compatible relational database with up to 5x the throughput of standard MySQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"mysql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard MySQL connections also work with mysqlclient.","categories":["CLOUD_AWS","HOSTED_OPEN_SOURCE"]}],"custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Unknown MySQL server host \"%(hostname)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down and can't be reached.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":59,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/oceanbase.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/oceanbase.mdx index 38feb42cf61..dee9acdef93 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/oceanbase.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/oceanbase.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.oceanbase","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":59,"max_score":201,"documentation":{"description":"OceanBase is a distributed relational database.","logo":"oceanbase.svg","homepage_url":"https://www.oceanbase.com/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["oceanbase_py"],"connection_string":"oceanbase://{username}:{password}@{host}:{port}/{database}","category":"Other Databases","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Unknown OceanBase server host \"%(hostname)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down and can't be reached.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"oceanbase","engine_name":"OceanBase","engine_aliases":["oceanbase","oceanbase_py"],"default_driver":"oceanbase","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"oceanbase","engine_name":"OceanBase","module":"oceanbase","documentation":{"description":"OceanBase is a distributed relational database.","logo":"oceanbase.svg","homepage_url":"https://www.oceanbase.com/","pypi_packages":["mysqlclient","oceanbase_py"],"connection_string":"oceanbase://{username}:{password}@{host}:{port}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"localhost, 127.0.0.1, IP address, or hostname","database":"Database name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."}],"categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Unknown OceanBase server host \"%(hostname)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down and can't be reached.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors near \"%(server_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/ocient.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/ocient.mdx index fffad0f2ba3..3997f250891 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/ocient.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/ocient.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":true,"YEAR":true},"module":"superset.db_engine_specs.ocient","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":false,"max_column_name":30,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":38,"max_score":201,"documentation":{"description":"Ocient is a hyperscale data analytics database.","categories":["Analytical Databases","Proprietary"],"pypi_packages":["sqlalchemy-ocient"],"connection_string":"ocient://{username}:{password}@{host}:{port}/{database}","install_instructions":"pip install sqlalchemy-ocient","category":"Other Databases","custom_errors":[{"regex_name":"CONNECTION_INVALID_USERNAME_REGEX","message_template":"The username \"%(username)s\" does not exist.","error_type":"CONNECTION_INVALID_USERNAME_ERROR","category":"Authentication","description":"Invalid username","issue_codes":[1012]},{"regex_name":"CONNECTION_INVALID_PASSWORD_REGEX","message_template":"The user/password combination is not valid (Incorrect password for user).","error_type":"CONNECTION_INVALID_PASSWORD_ERROR","category":"Authentication","description":"Invalid password","issue_codes":[1013]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Could not connect to database: \"%(database)s\"","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Could not resolve hostname: \"%(host)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_INVALID_PORT_ERROR","message_template":"Port out of range 0-65535","error_type":"CONNECTION_INVALID_PORT_ERROR"},{"regex_name":"INVALID_CONNECTION_STRING_REGEX","message_template":"Invalid Connection String: Expecting String of the form 'ocient://user:pass@host:port/database'.","error_type":"GENERIC_DB_ENGINE_ERROR","category":"General","description":"Database engine error","issue_codes":[1002]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Syntax Error: %(qualifier)s input \"%(input)s\" expecting \"%(expected)s","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"Table or View \"%(table)s\" does not exist.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"Invalid reference to column: \"%(column)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"engine":"ocient","engine_name":"Ocient","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"ocient","engine_name":"Ocient","module":"ocient","documentation":{"description":"Ocient is a hyperscale data analytics database.","categories":["ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["sqlalchemy-ocient"],"connection_string":"ocient://{username}:{password}@{host}:{port}/{database}","install_instructions":"pip install sqlalchemy-ocient","custom_errors":[{"regex_name":"CONNECTION_INVALID_USERNAME_REGEX","message_template":"The username \"%(username)s\" does not exist.","error_type":"CONNECTION_INVALID_USERNAME_ERROR","category":"Authentication","description":"Invalid username","issue_codes":[1012]},{"regex_name":"CONNECTION_INVALID_PASSWORD_REGEX","message_template":"The user/password combination is not valid (Incorrect password for user).","error_type":"CONNECTION_INVALID_PASSWORD_ERROR","category":"Authentication","description":"Invalid password","issue_codes":[1013]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Could not connect to database: \"%(database)s\"","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"Could not resolve hostname: \"%(host)s\".","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_INVALID_PORT_ERROR","message_template":"Port out of range 0-65535","error_type":"CONNECTION_INVALID_PORT_ERROR"},{"regex_name":"INVALID_CONNECTION_STRING_REGEX","message_template":"Invalid Connection String: Expecting String of the form 'ocient://user:pass@host:port/database'.","error_type":"GENERIC_DB_ENGINE_ERROR","category":"General","description":"Database engine error","issue_codes":[1002]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Syntax Error: %(qualifier)s input \"%(input)s\" expecting \"%(expected)s","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"Table or View \"%(table)s\" does not exist.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"Invalid reference to column: \"%(column)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":true,"YEAR":true},"score":38,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/opensearch-opendistro.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/opensearch-opendistro.mdx deleted file mode 100644 index 5fe70bbb58c..00000000000 --- a/docs/versioned_docs/version-6.1.0/databases/supported/opensearch-opendistro.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: OpenSearch (OpenDistro) -sidebar_label: OpenSearch (OpenDistro) -description: "Documentation for OpenSearch (OpenDistro) database connection." -hide_title: true ---- - -{/* -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF 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. -*/} - -import { DatabasePage } from '@site/src/components/databases'; - -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.elasticsearch","limit_method":1,"limit_clause":true,"joins":false,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":true,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":false,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":26,"max_score":201,"documentation":{"pypi_packages":[],"connection_string":"engine+driver://user:password@host:port/dbname[?key=value&key=value...]","category":"Other Databases"},"engine":"odelasticsearch","engine_name":"OpenSearch (OpenDistro)","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; - - diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/oracle.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/oracle.mdx index 0205c133e2b..4616cf1ad39 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/oracle.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/oracle.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.oracle","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Oracle Database is a multi-model database management system.","logo":"oraclelogo.png","homepage_url":"https://www.oracle.com/database/","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["oracledb"],"connection_string":"oracle://{username}:{password}@{hostname}:{port}","default_port":1521,"notes":"Previously used cx_Oracle, now uses oracledb.","docs_url":"https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html","category":"Other Databases"},"engine":"oracle","engine_name":"Oracle","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"oracle","engine_name":"Oracle","module":"oracle","documentation":{"description":"Oracle Database is a multi-model database management system.","logo":"oraclelogo.png","homepage_url":"https://www.oracle.com/database/","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["oracledb"],"connection_string":"oracle://{username}:{password}@{hostname}:{port}","default_port":1521,"notes":"Previously used cx_Oracle, now uses oracledb.","docs_url":"https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/parseable.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/parseable.mdx index f1e63991d9d..b07c83d3f34 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/parseable.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/parseable.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.parseable","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":28,"max_score":201,"documentation":{"description":"Parseable is a distributed log analytics database with SQL-like query interface.","categories":["Search & NoSQL","Open Source"],"pypi_packages":["sqlalchemy-parseable"],"connection_string":"parseable://{username}:{password}@{hostname}:{port}/{stream_name}","connection_examples":[{"description":"Example connection","connection_string":"parseable://admin:admin@demo.parseable.com:443/ingress-nginx"}],"notes":"Stream name in URI represents the Parseable logstream to query. Supports HTTP (80) and HTTPS (443).","docs_url":"https://www.parseable.io","category":"Other Databases"},"engine":"parseable","engine_name":"Parseable","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"parseable","engine_name":"Parseable","module":"parseable","documentation":{"description":"Parseable is a distributed log analytics database with SQL-like query interface.","categories":["SEARCH_NOSQL","OPEN_SOURCE"],"pypi_packages":["sqlalchemy-parseable"],"connection_string":"parseable://{username}:{password}@{hostname}:{port}/{stream_name}","connection_examples":[{"description":"Example connection","connection_string":"parseable://admin:admin@demo.parseable.com:443/ingress-nginx"}],"notes":"Stream name in URI represents the Parseable logstream to query. Supports HTTP (80) and HTTPS (443).","docs_url":"https://www.parseable.io"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":28,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/postgresql.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/postgresql.mdx index b4028907eac..b373f145109 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/postgresql.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/postgresql.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.postgres","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":63,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":true,"sql_validation":true,"score":104,"max_score":201,"documentation":{"description":"PostgreSQL is an advanced open-source relational database.","logo":"postgresql.svg","homepage_url":"https://www.postgresql.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://www.postgresql.org/docs/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","compatible_databases":[{"name":"Hologres","description":"Alibaba Cloud real-time interactive analytics service, fully compatible with PostgreSQL 11.","logo":"hologres.png","homepage_url":"https://www.alibabacloud.com/product/hologres","pypi_packages":["psycopg2"],"connection_string":"postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"AccessKey ID of your Alibaba Cloud account","password":"AccessKey secret of your Alibaba Cloud account","host":"Public endpoint of the Hologres instance","port":"Port number of the Hologres instance","database":"Name of the Hologres database"},"categories":["Proprietary"]},{"name":"TimescaleDB","description":"Open-source relational database for time-series and analytics, built on PostgreSQL.","logo":"timescale.png","homepage_url":"https://www.timescale.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Timescale Cloud (SSL required)","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://docs.timescale.com/","categories":["Open Source"]},{"name":"YugabyteDB","description":"Distributed SQL database built on top of PostgreSQL.","logo":"yugabyte.png","homepage_url":"https://www.yugabyte.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://www.yugabyte.com/","categories":["Open Source"]},{"name":"Supabase","description":"Open-source Firebase alternative built on top of PostgreSQL, providing a full backend-as-a-service with a hosted Postgres database.","logo":"supabase.svg","homepage_url":"https://supabase.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Supabase project (connection pooler)","connection_string":"postgresql://{username}.{project_ref}:{password}@aws-0-{region}.pooler.supabase.com:6543/{database}"}],"parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"Supabase project host (from project settings)","port":"Default 5432 (direct) or 6543 (pooler)","database":"Database name (default: postgres)","project_ref":"Supabase project reference (from project settings)","region":"Supabase project region (e.g., us-east-1)"},"notes":"Find connection details in your Supabase project dashboard under Settings > Database. Use the connection pooler (port 6543) for better connection management.","docs_url":"https://supabase.com/docs/guides/database/connecting-to-postgres","categories":["Hosted Open Source"]},{"name":"Google AlloyDB","description":"Google Cloud's PostgreSQL-compatible database service for demanding transactional and analytical workloads.","logo":"alloydb.png","homepage_url":"https://cloud.google.com/alloydb","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"AlloyDB instance IP or Auth Proxy address","port":"Default 5432","database":"Database name"},"notes":"For public IP connections, use the AlloyDB Auth Proxy for secure access. Private IP connections can connect directly.","docs_url":"https://cloud.google.com/alloydb/docs","categories":["Cloud - Google","Hosted Open Source"]},{"name":"Neon","description":"Serverless PostgreSQL with branching, scale-to-zero, and bottomless storage.","logo":"neon.png","homepage_url":"https://neon.tech/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}/{database}?sslmode=require","parameters":{"username":"Neon role name","password":"Neon role password","host":"Neon hostname (e.g., ep-cool-name-123456.us-east-2.aws.neon.tech)","database":"Database name (default: neondb)"},"notes":"SSL is required for all connections. Find connection details in the Neon console under Connection Details.","docs_url":"https://neon.tech/docs/connect/connect-from-any-app","categories":["Hosted Open Source"]},{"name":"Amazon Aurora PostgreSQL","description":"Amazon Aurora PostgreSQL is a fully managed, PostgreSQL-compatible relational database with up to 5x the throughput of standard PostgreSQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"postgresql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard PostgreSQL connections also work with psycopg2.","categories":["Cloud - AWS","Hosted Open Source"]}],"category":"Traditional RDBMS","custom_errors":[{"regex_name":"CONNECTION_INVALID_USERNAME_REGEX","message_template":"The username \"%(username)s\" does not exist.","error_type":"CONNECTION_INVALID_USERNAME_ERROR","category":"Authentication","description":"Invalid username","issue_codes":[1012],"invalid_fields":["username"]},{"regex_name":"CONNECTION_INVALID_PASSWORD_REGEX","message_template":"The password provided for username \"%(username)s\" is incorrect.","error_type":"CONNECTION_INVALID_PASSWORD_ERROR","category":"Authentication","description":"Invalid password","issue_codes":[1013],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_PASSWORD_NEEDED_REGEX","message_template":"Please re-enter the password.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"postgresql","engine_name":"PostgreSQL","engine_aliases":["postgres"],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"postgresql","engine_name":"PostgreSQL","module":"postgres","documentation":{"description":"PostgreSQL is an advanced open-source relational database.","logo":"postgresql.svg","homepage_url":"https://www.postgresql.org/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://www.postgresql.org/docs/","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","compatible_databases":[{"name":"Hologres","description":"Alibaba Cloud real-time interactive analytics service, fully compatible with PostgreSQL 11.","logo":"hologres.png","homepage_url":"https://www.alibabacloud.com/product/hologres","pypi_packages":["psycopg2"],"connection_string":"postgresql+psycopg2://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"AccessKey ID of your Alibaba Cloud account","password":"AccessKey secret of your Alibaba Cloud account","host":"Public endpoint of the Hologres instance","port":"Port number of the Hologres instance","database":"Name of the Hologres database"},"categories":["PROPRIETARY"]},{"name":"TimescaleDB","description":"Open-source relational database for time-series and analytics, built on PostgreSQL.","logo":"timescale.png","homepage_url":"https://www.timescale.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Timescale Cloud (SSL required)","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://docs.timescale.com/","categories":["OPEN_SOURCE"]},{"name":"YugabyteDB","description":"Distributed SQL database built on top of PostgreSQL.","logo":"yugabyte.png","homepage_url":"https://www.yugabyte.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","notes":"psycopg2 comes bundled with Superset Docker images.","docs_url":"https://www.yugabyte.com/","categories":["OPEN_SOURCE"]},{"name":"Supabase","description":"Open-source Firebase alternative built on top of PostgreSQL, providing a full backend-as-a-service with a hosted Postgres database.","logo":"supabase.svg","homepage_url":"https://supabase.com/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","connection_examples":[{"description":"Supabase project (connection pooler)","connection_string":"postgresql://{username}.{project_ref}:{password}@aws-0-{region}.pooler.supabase.com:6543/{database}"}],"parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"Supabase project host (from project settings)","port":"Default 5432 (direct) or 6543 (pooler)","database":"Database name (default: postgres)","project_ref":"Supabase project reference (from project settings)","region":"Supabase project region (e.g., us-east-1)"},"notes":"Find connection details in your Supabase project dashboard under Settings > Database. Use the connection pooler (port 6543) for better connection management.","docs_url":"https://supabase.com/docs/guides/database/connecting-to-postgres","categories":["HOSTED_OPEN_SOURCE"]},{"name":"Google AlloyDB","description":"Google Cloud's PostgreSQL-compatible database service for demanding transactional and analytical workloads.","logo":"alloydb.png","homepage_url":"https://cloud.google.com/alloydb","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","parameters":{"username":"Database user (default: postgres)","password":"Database password","host":"AlloyDB instance IP or Auth Proxy address","port":"Default 5432","database":"Database name"},"notes":"For public IP connections, use the AlloyDB Auth Proxy for secure access. Private IP connections can connect directly.","docs_url":"https://cloud.google.com/alloydb/docs","categories":["CLOUD_GCP","HOSTED_OPEN_SOURCE"]},{"name":"Neon","description":"Serverless PostgreSQL with branching, scale-to-zero, and bottomless storage.","logo":"neon.png","homepage_url":"https://neon.tech/","pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}/{database}?sslmode=require","parameters":{"username":"Neon role name","password":"Neon role password","host":"Neon hostname (e.g., ep-cool-name-123456.us-east-2.aws.neon.tech)","database":"Database name (default: neondb)"},"notes":"SSL is required for all connections. Find connection details in the Neon console under Connection Details.","docs_url":"https://neon.tech/docs/connect/connect-from-any-app","categories":["HOSTED_OPEN_SOURCE"]},{"name":"Amazon Aurora PostgreSQL","description":"Amazon Aurora PostgreSQL is a fully managed, PostgreSQL-compatible relational database with up to 5x the throughput of standard PostgreSQL.","logo":"aws-aurora.jpg","homepage_url":"https://aws.amazon.com/rds/aurora/","pypi_packages":["sqlalchemy-aurora-data-api"],"connection_string":"postgresql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}®ion_name={region_name}","parameters":{"aws_access_id":"AWS Access Key ID","aws_secret_access_key":"AWS Secret Access Key","database_name":"Database name","aurora_cluster_arn":"Aurora cluster ARN","secret_arn":"Secrets Manager ARN for credentials","region_name":"AWS region (e.g., us-east-1)"},"notes":"Uses the Data API for serverless access. Standard PostgreSQL connections also work with psycopg2.","categories":["CLOUD_AWS","HOSTED_OPEN_SOURCE"]}],"custom_errors":[{"regex_name":"CONNECTION_INVALID_USERNAME_REGEX","message_template":"The username \"%(username)s\" does not exist.","error_type":"CONNECTION_INVALID_USERNAME_ERROR","category":"Authentication","description":"Invalid username","issue_codes":[1012],"invalid_fields":["username"]},{"regex_name":"CONNECTION_INVALID_PASSWORD_REGEX","message_template":"The password provided for username \"%(username)s\" is incorrect.","error_type":"CONNECTION_INVALID_PASSWORD_ERROR","category":"Authentication","description":"Invalid password","issue_codes":[1013],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_INVALID_PASSWORD_NEEDED_REGEX","message_template":"Please re-enter the password.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["password"]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007],"invalid_fields":["host"]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009],"invalid_fields":["host","port"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]},{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":104,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":true,"sql_validation":true}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/presto.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/presto.mdx index 38d86c2d48e..90bd03735ee 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/presto.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/presto.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.presto","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":true,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":true,"expand_data":true,"query_cost_estimation":true,"sql_validation":true,"score":159,"max_score":201,"documentation":{"description":"Presto is a distributed SQL query engine for big data.","logo":"presto-og.png","homepage_url":"https://prestodb.io/","categories":["Query Engines","Open Source"],"pypi_packages":["pyhive"],"install_instructions":"pip install \"apache-superset[presto]\"","connection_string":"presto://{hostname}:{port}/{database}","default_port":8080,"parameters":{"hostname":"Presto coordinator hostname","port":"Presto coordinator port (default 8080)","database":"Catalog name"},"drivers":[{"name":"PyHive","pypi_package":"pyhive","connection_string":"presto://{hostname}:{port}/{database}","is_recommended":true}],"category":"Query Engines","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table_name)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema_name)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_ERROR","message_template":"Unable to connect to catalog named \"%(catalog_name)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015]}]},"engine":"presto","engine_name":"Presto","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"presto","engine_name":"Presto","module":"presto","documentation":{"description":"Presto is a distributed SQL query engine for big data.","logo":"presto-og.png","homepage_url":"https://prestodb.io/","categories":["QUERY_ENGINES","OPEN_SOURCE"],"pypi_packages":["pyhive"],"install_instructions":"pip install \"apache-superset[presto]\"","connection_string":"presto://{hostname}:{port}/{database}","default_port":8080,"parameters":{"hostname":"Presto coordinator hostname","port":"Presto coordinator port (default 8080)","database":"Catalog name"},"drivers":[{"name":"PyHive","pypi_package":"pyhive","connection_string":"presto://{hostname}:{port}/{database}","is_recommended":true}],"custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\" at line %(location)s.","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]},{"regex_name":"TABLE_DOES_NOT_EXIST_REGEX","message_template":"The table \"%(table_name)s\" does not exist. A valid table must be used to run this query.","error_type":"TABLE_DOES_NOT_EXIST_ERROR","category":"Query","description":"Table not found","issue_codes":[1003,1005]},{"regex_name":"SCHEMA_DOES_NOT_EXIST_REGEX","message_template":"The schema \"%(schema_name)s\" does not exist. A valid schema must be used to run this query.","error_type":"SCHEMA_DOES_NOT_EXIST_ERROR","category":"Query","description":"Schema not found","issue_codes":[1003,1016]},{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015]},{"regex_name":"CONNECTION_INVALID_HOSTNAME_REGEX","message_template":"The hostname \"%(hostname)s\" cannot be resolved.","error_type":"CONNECTION_INVALID_HOSTNAME_ERROR","category":"Connection","description":"Invalid hostname","issue_codes":[1007]},{"regex_name":"CONNECTION_HOST_DOWN_REGEX","message_template":"The host \"%(hostname)s\" might be down, and can't be reached on port %(port)s.","error_type":"CONNECTION_HOST_DOWN_ERROR","category":"Connection","description":"Host unreachable","issue_codes":[1009]},{"regex_name":"CONNECTION_PORT_CLOSED_REGEX","message_template":"Port %(port)s on hostname \"%(hostname)s\" refused the connection.","error_type":"CONNECTION_PORT_CLOSED_ERROR","category":"Connection","description":"Port closed or refused","issue_codes":[1008]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_ERROR","message_template":"Unable to connect to catalog named \"%(catalog_name)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":159,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":true,"query_cost_estimation":true,"sql_validation":true}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/risingwave.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/risingwave.mdx index 359e50a492c..10a74889a65 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/risingwave.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/risingwave.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.risingwave","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":63,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":true,"sql_validation":false,"score":94,"max_score":201,"documentation":{"description":"RisingWave is a distributed streaming database.","logo":"risingwave.svg","homepage_url":"https://risingwave.com/","categories":["Analytical Databases","Open Source"],"pypi_packages":["sqlalchemy-risingwave"],"connection_string":"risingwave://root@{hostname}:{port}/{database}?sslmode=disable","default_port":4566,"docs_url":"https://github.com/risingwavelabs/sqlalchemy-risingwave","category":"Other Databases"},"engine":"risingwave","engine_name":"RisingWave","engine_aliases":["postgres"],"default_driver":"","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"risingwave","engine_name":"RisingWave","module":"risingwave","documentation":{"description":"RisingWave is a distributed streaming database.","logo":"risingwave.svg","homepage_url":"https://risingwave.com/","pypi_packages":["psycopg2","sqlalchemy-risingwave"],"connection_string":"risingwave://root@{hostname}:{port}/{database}?sslmode=disable","default_port":4566,"parameters":{"username":"Database username","password":"Database password","host":"For localhost: localhost or 127.0.0.1. For AWS: endpoint URL","port":"Default 5432","database":"Database name"},"notes":"The psycopg2 library comes bundled with Superset Docker images.","connection_examples":[{"description":"Basic connection","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}"},{"description":"With SSL required","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"docs_url":"https://github.com/risingwavelabs/sqlalchemy-risingwave","sqlalchemy_docs_url":"https://docs.sqlalchemy.org/en/13/dialects/postgresql.html","categories":["ANALYTICAL_DATABASES","OPEN_SOURCE"]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":94,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":true,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/sap-hana.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/sap-hana.mdx index cb688b87c55..c424c94fcc2 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/sap-hana.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/sap-hana.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.hana","limit_method":2,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":30,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":27,"max_score":201,"documentation":{"description":"SAP HANA is an in-memory relational database and application platform.","logo":"sap-hana.png","homepage_url":"https://www.sap.com/products/technology-platform/hana.html","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["hdbcli","sqlalchemy-hana"],"install_instructions":"pip install apache_superset[hana]","connection_string":"hana://{username}:{password}@{host}:{port}","default_port":30015,"docs_url":"https://github.com/SAP/sqlalchemy-hana","category":"Other Databases"},"engine":"hana","engine_name":"SAP HANA","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"sap_hana","engine_name":"SAP HANA","module":"hana","documentation":{"description":"SAP HANA is an in-memory relational database and application platform.","logo":"sap-hana.png","homepage_url":"https://www.sap.com/products/technology-platform/hana.html","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["hdbcli","sqlalchemy-hana"],"install_instructions":"pip install apache_superset[hana]","connection_string":"hana://{username}:{password}@{host}:{port}","default_port":30015,"docs_url":"https://github.com/SAP/sqlalchemy-hana"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":false,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":27,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/sap-sybase.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/sap-sybase.mdx index ca90dee5341..16109d80e69 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/sap-sybase.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/sap-sybase.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.sybase","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":false,"max_column_name":128,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":44,"max_score":201,"documentation":{"description":"SAP ASE (formerly Sybase) is an enterprise relational database.","logo":"sybase.png","homepage_url":"https://www.sap.com/products/technology-platform/sybase-ase.html","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["sqlalchemy-sybase","pyodbc"],"connection_string":"sybase+pyodbc://{username}:{password}@{dsn}","parameters":{"username":"Database username","password":"Database password","dsn":"ODBC Data Source Name configured for SAP ASE"},"notes":"Requires SAP ASE ODBC driver installed and configured as a DSN.","docs_url":"https://help.sap.com/docs/SAP_ASE","category":"Other Databases"},"engine":"sybase","engine_name":"SAP Sybase","engine_aliases":["sybase_sqlany"],"default_driver":"pyodbc","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"sap_sybase","engine_name":"SAP Sybase","module":"sybase","documentation":{"description":"SAP ASE (formerly Sybase) is an enterprise relational database.","logo":"sybase.png","homepage_url":"https://www.sap.com/products/technology-platform/sybase-ase.html","pypi_packages":["pymssql","sqlalchemy-sybase","pyodbc"],"connection_string":"sybase+pyodbc://{username}:{password}@{dsn}","default_port":1433,"drivers":[{"name":"pymssql","pypi_package":"pymssql","connection_string":"mssql+pymssql://{username}:{password}@{host}:{port}/{database}","is_recommended":true},{"name":"pyodbc","pypi_package":"pyodbc","connection_string":"mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3C{host}%3E%2C1433%3BDatabase%3D{database}%3BUid%3D{username}%3BPwd%3D{password}%3BEncrypt%3Dyes%3BConnection+Timeout%3D30","is_recommended":false,"notes":"Connection string must be URL-encoded. Special characters like @ need encoding."}],"docs_url":"https://help.sap.com/docs/SAP_ASE","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"parameters":{"username":"Database username","password":"Database password","dsn":"ODBC Data Source Name configured for SAP ASE"},"notes":"Requires SAP ASE ODBC driver installed and configured as a DSN."},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/shillelagh.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/shillelagh.mdx index cb04e812786..4dc3a6be82f 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/shillelagh.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/shillelagh.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"module":"superset.db_engine_specs.shillelagh","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":true,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":41,"max_score":201,"documentation":{"description":"Shillelagh is a Python library that allows querying many data sources using SQL, including Google Sheets, CSV files, and APIs.","logo":"shillelagh.png","homepage_url":"https://shillelagh.readthedocs.io/","categories":["Other Databases","Open Source"],"pypi_packages":["shillelagh[gsheetsapi]"],"connection_string":"shillelagh://","notes":"Shillelagh uses virtual tables to query external data sources. Google Sheets requires OAuth credentials configured.","category":"Other Databases"},"engine":"shillelagh","engine_name":"Shillelagh","engine_aliases":[],"default_driver":"apsw","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"shillelagh","engine_name":"Shillelagh","module":"shillelagh","documentation":{"description":"Shillelagh is a Python library that allows querying many data sources using SQL, including Google Sheets, CSV files, and APIs.","logo":"shillelagh.png","homepage_url":"https://shillelagh.readthedocs.io/","pypi_packages":["shillelagh[gsheetsapi]"],"connection_string":"shillelagh://","notes":"Shillelagh uses virtual tables to query external data sources. Google Sheets requires OAuth credentials configured.","categories":["OTHER","OPEN_SOURCE"]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/singlestore.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/singlestore.mdx index 73e8586c3d6..0abc488eea6 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/singlestore.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/singlestore.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.singlestore","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":256,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":68,"max_score":201,"documentation":{"description":"SingleStore is a distributed SQL database for real-time analytics and transactions.","logo":"singlestore.png","homepage_url":"https://www.singlestore.com/","categories":["Analytical Databases","Proprietary"],"pypi_packages":["singlestoredb"],"connection_string":"singlestoredb://{username}:{password}@{host}:{port}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"SingleStore host","port":"SingleStore port (default 3306)","database":"Database name"},"drivers":[{"name":"singlestoredb","pypi_package":"singlestoredb","connection_string":"singlestoredb://{username}:{password}@{host}:{port}/{database}","is_recommended":true}],"category":"Other Databases"},"engine":"singlestoredb","engine_name":"SingleStore","engine_aliases":[],"default_driver":"singlestoredb","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"singlestore","engine_name":"SingleStore","module":"singlestore","documentation":{"description":"SingleStore is a distributed SQL database for real-time analytics and transactions.","logo":"singlestore.png","homepage_url":"https://www.singlestore.com/","categories":["ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["singlestoredb"],"connection_string":"singlestoredb://{username}:{password}@{host}:{port}/{database}","default_port":3306,"parameters":{"username":"Database username","password":"Database password","host":"SingleStore host","port":"SingleStore port (default 3306)","database":"Database name"},"drivers":[{"name":"singlestoredb","pypi_package":"singlestoredb","connection_string":"singlestoredb://{username}:{password}@{host}:{port}/{database}","is_recommended":true}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":68,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/snowflake.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/snowflake.mdx index b29da4433c3..4b478f95efb 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/snowflake.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/snowflake.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.snowflake","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":256,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":72,"max_score":201,"documentation":{"description":"Snowflake is a cloud-native data warehouse.","logo":"snowflake.svg","homepage_url":"https://www.snowflake.com/","categories":["Cloud Data Warehouses","Analytical Databases","Proprietary"],"pypi_packages":["snowflake-sqlalchemy"],"connection_string":"snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}","install_instructions":"echo \"snowflake-sqlalchemy\" >> ./docker/requirements-local.txt","connection_examples":[{"description":"With role and warehouse","connection_string":"snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}"},{"description":"With defaults (role/warehouse optional)","connection_string":"snowflake://{user}:{password}@{account}.{region}/{database}"}],"authentication_methods":[{"name":"Key Pair Authentication","description":"Use RSA key pair instead of password","requirements":"Key pair must be generated and public key registered in Snowflake","notes":"Merge multi-line private key to one line with \\n between lines."}],"notes":"Schema is not required in connection string. Ensure user has privileges for all databases/schemas/tables/views/warehouses.","docs_url":"https://docs.snowflake.com/en/user-guide/key-pair-auth.html","category":"Cloud Data Warehouses","custom_errors":[{"regex_name":"OBJECT_DOES_NOT_EXIST_REGEX","message_template":"%(object)s does not exist in this database.","error_type":"OBJECT_DOES_NOT_EXIST_ERROR","category":"Query","description":"Object not found","issue_codes":[1029]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"engine":"snowflake","engine_name":"Snowflake","engine_aliases":[],"default_driver":"snowflake","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"snowflake","engine_name":"Snowflake","module":"snowflake","documentation":{"description":"Snowflake is a cloud-native data warehouse.","logo":"snowflake.svg","homepage_url":"https://www.snowflake.com/","categories":["CLOUD_DATA_WAREHOUSES","ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["snowflake-sqlalchemy"],"connection_string":"snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}","install_instructions":"echo \"snowflake-sqlalchemy\" >> ./docker/requirements-local.txt","connection_examples":[{"description":"With role and warehouse","connection_string":"snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}"},{"description":"With defaults (role/warehouse optional)","connection_string":"snowflake://{user}:{password}@{account}.{region}/{database}"}],"authentication_methods":[{"name":"Key Pair Authentication","description":"Use RSA key pair instead of password","requirements":"Key pair must be generated and public key registered in Snowflake","notes":"Merge multi-line private key to one line with \\n between lines."}],"notes":"Schema is not required in connection string. Ensure user has privileges for all databases/schemas/tables/views/warehouses.","docs_url":"https://docs.snowflake.com/en/user-guide/key-pair-auth.html","custom_errors":[{"regex_name":"OBJECT_DOES_NOT_EXIST_REGEX","message_template":"%(object)s does not exist in this database.","error_type":"OBJECT_DOES_NOT_EXIST_ERROR","category":"Query","description":"Object not found","issue_codes":[1029]},{"regex_name":"SYNTAX_ERROR_REGEX","message_template":"Please check your query for syntax errors at or near \"%(syntax_error)s\". Then, try running your query again.","error_type":"SYNTAX_ERROR","category":"Query","description":"SQL syntax error","issue_codes":[1030]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":72,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/sqlite.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/sqlite.mdx index 00712bd53c4..87e7697db5f 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/sqlite.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/sqlite.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"module":"superset.db_engine_specs.sqlite","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":true,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":41,"max_score":201,"documentation":{"description":"SQLite is a self-contained, serverless SQL database engine.","logo":"sqlite.png","homepage_url":"https://www.sqlite.org/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":[],"connection_string":"sqlite:///path/to/file.db?check_same_thread=false","notes":"No additional library needed. SQLite is bundled with Python.","category":"Traditional RDBMS","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"engine":"sqlite","engine_name":"SQLite","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"sqlite","engine_name":"SQLite","module":"sqlite","documentation":{"description":"SQLite is a self-contained, serverless SQL database engine.","logo":"sqlite.png","homepage_url":"https://www.sqlite.org/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":[],"connection_string":"sqlite:///path/to/file.db?check_same_thread=false","notes":"No additional library needed. SQLite is bundled with Python.","custom_errors":[{"regex_name":"COLUMN_DOES_NOT_EXIST_REGEX","message_template":"We can't seem to resolve the column \"%(column_name)s\"","error_type":"COLUMN_DOES_NOT_EXIST_ERROR","category":"Query","description":"Column not found","issue_codes":[1003,1004]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"score":41,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/starrocks.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/starrocks.mdx index 33c76bf749f..119416e9a1c 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/starrocks.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/starrocks.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.starrocks","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":false,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":89,"max_score":201,"documentation":{"description":"StarRocks is a high-performance analytical database for real-time analytics.","logo":"starrocks.png","homepage_url":"https://www.starrocks.io/","categories":["Analytical Databases","Open Source"],"pypi_packages":["starrocks"],"connection_string":"starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}","default_port":9030,"parameters":{"username":"Database username","password":"Database password","host":"StarRocks FE host","port":"Query port (default 9030)","catalog":"Catalog name","database":"Database name"},"drivers":[{"name":"starrocks","pypi_package":"starrocks","connection_string":"starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}","is_recommended":true},{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}:{port}/{database}","is_recommended":false,"notes":"MySQL-compatible driver for StarRocks."},{"name":"PyMySQL","pypi_package":"pymysql","connection_string":"mysql+pymysql://{username}:{password}@{host}:{port}/{database}","is_recommended":false,"notes":"Pure Python MySQL driver, no compilation required."}],"compatible_databases":[{"name":"CelerData","description":"CelerData is a fully-managed cloud analytics service built on StarRocks. It provides instant elasticity, automatic scaling, and enterprise features.","logo":"celerdata.png","homepage_url":"https://celerdata.com/","categories":["Analytical Databases","Cloud Data Warehouses","Hosted Open Source"],"pypi_packages":["starrocks"],"connection_string":"starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}","parameters":{"username":"CelerData username","password":"CelerData password","host":"CelerData cluster endpoint","port":"Query port (default 9030)","catalog":"Catalog name","database":"Database name"},"docs_url":"https://docs.celerdata.com/"}],"category":"Analytical Databases","custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]}]},"engine":"starrocks","engine_name":"StarRocks","engine_aliases":[],"default_driver":"starrocks","supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"starrocks","engine_name":"StarRocks","module":"starrocks","documentation":{"description":"StarRocks is a high-performance analytical database for real-time analytics.","logo":"starrocks.png","homepage_url":"https://www.starrocks.io/","pypi_packages":["mysqlclient","starrocks"],"connection_string":"starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}","default_port":9030,"parameters":{"username":"Database username","password":"Database password","host":"StarRocks FE host","database":"Database name","port":"Query port (default 9030)","catalog":"Catalog name"},"host_examples":[{"platform":"Localhost","host":"localhost or 127.0.0.1"},{"platform":"Docker on Linux","host":"172.18.0.1"},{"platform":"Docker on macOS","host":"docker.for.mac.host.internal"},{"platform":"On-premise","host":"IP address or hostname"}],"drivers":[{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}/{database}","is_recommended":true,"notes":"Recommended driver. May fail with caching_sha2_password auth."},{"name":"mysql-connector-python","pypi_package":"mysql-connector-python","connection_string":"mysql+mysqlconnector://{username}:{password}@{host}/{database}","is_recommended":false,"notes":"Required for newer MySQL databases using caching_sha2_password authentication."},{"name":"starrocks","pypi_package":"starrocks","connection_string":"starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}","is_recommended":true},{"name":"mysqlclient","pypi_package":"mysqlclient","connection_string":"mysql://{username}:{password}@{host}:{port}/{database}","is_recommended":false,"notes":"MySQL-compatible driver for StarRocks."},{"name":"PyMySQL","pypi_package":"pymysql","connection_string":"mysql+pymysql://{username}:{password}@{host}:{port}/{database}","is_recommended":false,"notes":"Pure Python MySQL driver, no compilation required."}],"categories":["ANALYTICAL_DATABASES","OPEN_SOURCE"],"compatible_databases":[{"name":"CelerData","description":"CelerData is a fully-managed cloud analytics service built on StarRocks. It provides instant elasticity, automatic scaling, and enterprise features.","logo":"celerdata.png","homepage_url":"https://celerdata.com/","categories":["ANALYTICAL_DATABASES","CLOUD_DATA_WAREHOUSES","HOSTED_OPEN_SOURCE"],"pypi_packages":["starrocks"],"connection_string":"starrocks://{username}:{password}@{host}:{port}/{catalog}.{database}","parameters":{"username":"CelerData username","password":"CelerData password","host":"CelerData cluster endpoint","port":"Query port (default 9030)","catalog":"Catalog name","database":"Database name"},"docs_url":"https://docs.celerdata.com/"}],"custom_errors":[{"regex_name":"CONNECTION_ACCESS_DENIED_REGEX","message_template":"Either the username \"%(username)s\" or the password is incorrect.","error_type":"CONNECTION_ACCESS_DENIED_ERROR","category":"Authentication","description":"Access denied","issue_codes":[1014,1015],"invalid_fields":["username","password"]},{"regex_name":"CONNECTION_UNKNOWN_DATABASE_REGEX","message_template":"Unable to connect to database \"%(database)s\".","error_type":"CONNECTION_UNKNOWN_DATABASE_ERROR","category":"Connection","description":"Unknown database","issue_codes":[1015],"invalid_fields":["database"]}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":69,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":true,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/superset-meta-database.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/superset-meta-database.mdx index 911cf2a096b..d48d26b3304 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/superset-meta-database.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/superset-meta-database.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":true,"YEAR":true},"module":"superset.db_engine_specs.superset","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":true,"user_impersonation":false,"file_upload":false,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":31,"max_score":201,"documentation":{"description":"Superset meta database is an experimental feature that enables querying across multiple configured databases using a single connection.","logo":"superset.svg","homepage_url":"https://superset.apache.org/","categories":["Other Databases"],"pypi_packages":[],"connection_string":"superset://","notes":"This is an internal Superset feature. Enable with ENABLE_SUPERSET_META_DB feature flag. Allows cross-database queries using virtual tables.","category":"Other Databases"},"engine":"superset","engine_name":"Superset meta database","engine_aliases":[],"default_driver":"","supports_file_upload":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"superset_meta_database","engine_name":"Superset meta database","module":"superset","documentation":{"description":"Superset meta database is an experimental feature that enables querying across multiple configured databases using a single connection.","logo":"superset.svg","homepage_url":"https://superset.apache.org/","pypi_packages":["shillelagh[gsheetsapi]"],"connection_string":"superset://","notes":"This is an internal Superset feature. Enable with ENABLE_SUPERSET_META_DB feature flag. Allows cross-database queries using virtual tables.","categories":["OTHER"]},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/tdengine.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/tdengine.mdx index ff417a50b9c..0d3281df577 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/tdengine.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/tdengine.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":false,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":false},"module":"superset.db_engine_specs.tdengine","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":64,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":25,"max_score":201,"documentation":{"description":"TDengine is a high-performance time-series database for IoT.","logo":"tdengine.png","homepage_url":"https://tdengine.com/","categories":["Time Series Databases","Open Source"],"pypi_packages":["taospy","taos-ws-py"],"connection_string":"taosws://{user}:{password}@{host}:{port}","default_port":6041,"connection_examples":[{"description":"Local connection","connection_string":"taosws://root:taosdata@127.0.0.1:6041"}],"docs_url":"https://www.tdengine.com","category":"Other Databases"},"engine":"taosws","engine_name":"TDengine","engine_aliases":[],"default_driver":"taosws","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"tdengine","engine_name":"TDengine","module":"tdengine","documentation":{"description":"TDengine is a high-performance time-series database for IoT.","logo":"tdengine.png","homepage_url":"https://tdengine.com/","categories":["TIME_SERIES","OPEN_SOURCE"],"pypi_packages":["taospy","taos-ws-py"],"connection_string":"taosws://{user}:{password}@{host}:{port}","default_port":6041,"connection_examples":[{"description":"Local connection","connection_string":"taosws://root:taosdata@127.0.0.1:6041"}],"docs_url":"https://www.tdengine.com"},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":false,"QUARTER":false,"QUARTER_YEAR":false,"YEAR":false},"score":25,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/teradata.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/teradata.mdx index c4d918f85fb..c91a9f8fe56 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/teradata.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/teradata.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.teradata","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":30,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":27,"max_score":201,"documentation":{"description":"Teradata is an enterprise data warehouse platform.","logo":"teradata.png","homepage_url":"https://www.teradata.com/","categories":["Traditional RDBMS","Proprietary"],"pypi_packages":["teradatasqlalchemy"],"connection_string":"teradatasql://{user}:{password}@{host}","default_port":1025,"drivers":[{"name":"teradatasqlalchemy (Recommended)","pypi_package":"teradatasqlalchemy","connection_string":"teradatasql://{user}:{password}@{host}","is_recommended":true,"notes":"No ODBC drivers required."},{"name":"sqlalchemy-teradata (ODBC)","pypi_package":"sqlalchemy-teradata","is_recommended":false,"notes":"Requires ODBC driver installation.","docs_url":"https://downloads.teradata.com/download/connectivity/odbc-driver/linux"}],"category":"Other Databases"},"engine":"teradatasql","engine_name":"Teradata","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"teradata","engine_name":"Teradata","module":"teradata","documentation":{"description":"Teradata is an enterprise data warehouse platform.","logo":"teradata.png","homepage_url":"https://www.teradata.com/","categories":["TRADITIONAL_RDBMS","PROPRIETARY"],"pypi_packages":["teradatasqlalchemy"],"connection_string":"teradatasql://{user}:{password}@{host}","default_port":1025,"drivers":[{"name":"teradatasqlalchemy (Recommended)","pypi_package":"teradatasqlalchemy","connection_string":"teradatasql://{user}:{password}@{host}","is_recommended":true,"notes":"No ODBC drivers required."},{"name":"sqlalchemy-teradata (ODBC)","pypi_package":"sqlalchemy-teradata","is_recommended":false,"notes":"Requires ODBC driver installation.","docs_url":"https://downloads.teradata.com/download/connectivity/odbc-driver/linux"}]},"time_grains":{"SECOND":false,"FIVE_SECONDS":false,"THIRTY_SECONDS":false,"MINUTE":true,"FIVE_MINUTES":false,"TEN_MINUTES":false,"FIFTEEN_MINUTES":false,"THIRTY_MINUTES":false,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":27,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/timescaledb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/timescaledb.mdx index 8ab7804864f..a5dfcaaec1a 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/timescaledb.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/timescaledb.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.timescaledb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":34,"max_score":201,"documentation":{"description":"TimescaleDB is an open-source relational database for time-series and analytics, built on PostgreSQL.","logo":"timescale.png","homepage_url":"https://www.timescale.com/","categories":["Analytical Databases","Open Source"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"connection_examples":[{"description":"Timescale Cloud (SSL required)","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"notes":"Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.","docs_url":"https://docs.timescale.com/","category":"Other Databases"},"engine":"timescaledb","engine_name":"TimescaleDB","engine_aliases":[],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"timescaledb","engine_name":"TimescaleDB","module":"timescaledb","documentation":{"description":"TimescaleDB is an open-source relational database for time-series and analytics, built on PostgreSQL.","logo":"timescale.png","homepage_url":"https://www.timescale.com/","categories":["ANALYTICAL_DATABASES","OPEN_SOURCE"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5432,"connection_examples":[{"description":"Timescale Cloud (SSL required)","connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}?sslmode=require"}],"notes":"Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.","docs_url":"https://docs.timescale.com/"},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/trino.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/trino.mdx index ff360c2be4a..5019c87080c 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/trino.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/trino.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.trino","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":true,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":true,"function_names":true,"user_impersonation":true,"file_upload":true,"get_extra_table_metadata":true,"dbapi_exception_mapping":true,"custom_errors":false,"dynamic_schema":true,"catalog":true,"dynamic_catalog":true,"ssh_tunneling":true,"query_cancelation":true,"get_metrics":false,"where_latest_partition":true,"expand_data":false,"query_cost_estimation":true,"sql_validation":false,"score":149,"max_score":201,"documentation":{"description":"Trino is a distributed SQL query engine for big data analytics.","logo":"trino.png","homepage_url":"https://trino.io/","categories":["Query Engines","Open Source"],"pypi_packages":["trino"],"install_instructions":"pip install \"apache-superset[trino]\"","connection_string":"trino://{username}:{password}@{hostname}:{port}/{catalog}","default_port":8080,"parameters":{"username":"Trino username","password":"Trino password (if authentication is enabled)","hostname":"Trino coordinator hostname","port":"Trino coordinator port (default 8080)","catalog":"Catalog name"},"drivers":[{"name":"trino","pypi_package":"trino","connection_string":"trino://{username}:{password}@{hostname}:{port}/{catalog}","is_recommended":true}],"compatible_databases":[{"name":"Starburst Galaxy","description":"Starburst Galaxy is a fully-managed cloud analytics platform built on Trino. It provides data lake analytics with enterprise security and governance.","logo":"starburst.png","homepage_url":"https://www.starburst.io/platform/starburst-galaxy/","categories":["Query Engines","Cloud Data Warehouses","Hosted Open Source"],"pypi_packages":["trino"],"connection_string":"trino://{username}:{password}@{host}:{port}/{catalog}","parameters":{"username":"Starburst Galaxy username (email/role)","password":"Starburst Galaxy password or token","host":"Your Galaxy cluster hostname","port":"Port (default 443)","catalog":"Catalog name"},"docs_url":"https://docs.starburst.io/starburst-galaxy/"},{"name":"Starburst Enterprise","description":"Starburst Enterprise is a self-managed Trino distribution with enterprise features, security, and support.","logo":"starburst.png","homepage_url":"https://www.starburst.io/platform/starburst-enterprise/","categories":["Query Engines","Hosted Open Source"],"pypi_packages":["trino"],"connection_string":"trino://{username}:{password}@{hostname}:{port}/{catalog}","docs_url":"https://docs.starburst.io/"}],"category":"Query Engines"},"engine":"trino","engine_name":"Trino","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":true}; +export const databaseInfo = {"engine":"trino","engine_name":"Trino","module":"trino","documentation":{"description":"Trino is a distributed SQL query engine for big data analytics.","logo":"trino.png","homepage_url":"https://trino.io/","categories":["QUERY_ENGINES","OPEN_SOURCE"],"pypi_packages":["trino"],"install_instructions":"pip install \"apache-superset[trino]\"","connection_string":"trino://{username}:{password}@{hostname}:{port}/{catalog}","default_port":8080,"parameters":{"username":"Trino username","password":"Trino password (if authentication is enabled)","hostname":"Trino coordinator hostname","port":"Trino coordinator port (default 8080)","catalog":"Catalog name"},"drivers":[{"name":"trino","pypi_package":"trino","connection_string":"trino://{username}:{password}@{hostname}:{port}/{catalog}","is_recommended":true}],"compatible_databases":[{"name":"Starburst Galaxy","description":"Starburst Galaxy is a fully-managed cloud analytics platform built on Trino. It provides data lake analytics with enterprise security and governance.","logo":"starburst.png","homepage_url":"https://www.starburst.io/platform/starburst-galaxy/","categories":["QUERY_ENGINES","CLOUD_DATA_WAREHOUSES","HOSTED_OPEN_SOURCE"],"pypi_packages":["trino"],"connection_string":"trino://{username}:{password}@{host}:{port}/{catalog}","parameters":{"username":"Starburst Galaxy username (email/role)","password":"Starburst Galaxy password or token","host":"Your Galaxy cluster hostname","port":"Port (default 443)","catalog":"Catalog name"},"docs_url":"https://docs.starburst.io/starburst-galaxy/"},{"name":"Starburst Enterprise","description":"Starburst Enterprise is a self-managed Trino distribution with enterprise features, security, and support.","logo":"starburst.png","homepage_url":"https://www.starburst.io/platform/starburst-enterprise/","categories":["QUERY_ENGINES","HOSTED_OPEN_SOURCE"],"pypi_packages":["trino"],"connection_string":"trino://{username}:{password}@{hostname}:{port}/{catalog}","docs_url":"https://docs.starburst.io/"}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":false,"HALF_HOUR":true,"HOUR":true,"SIX_HOURS":true,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":true,"WEEK_STARTING_MONDAY":true,"WEEK_ENDING_SATURDAY":true,"WEEK_ENDING_SUNDAY":true,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":149,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":true,"supports_catalog":true,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":true,"supports_file_upload":true,"user_impersonation":true,"query_cost_estimation":true,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/vertica.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/vertica.mdx index 8cd1b4433db..084cb580c40 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/vertica.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/vertica.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.vertica","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":34,"max_score":201,"documentation":{"description":"Vertica is a column-oriented analytics database.","logo":"vertica.png","homepage_url":"https://www.vertica.com/","categories":["Analytical Databases","Proprietary"],"pypi_packages":["sqlalchemy-vertica-python"],"connection_string":"vertica+vertica_python://{username}:{password}@{host}/{database}","default_port":5433,"parameters":{"username":"Database username","password":"Database password","host":"localhost, IP address, or hostname (cloud or on-prem)","database":"Database name","port":"Default 5433"},"notes":"Supports load balancer backup host configuration.","docs_url":"http://www.vertica.com/","category":"Analytical Databases"},"engine":"vertica","engine_name":"Vertica","engine_aliases":[],"default_driver":null,"supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"vertica","engine_name":"Vertica","module":"vertica","documentation":{"description":"Vertica is a column-oriented analytics database.","logo":"vertica.png","homepage_url":"https://www.vertica.com/","categories":["ANALYTICAL_DATABASES","PROPRIETARY"],"pypi_packages":["sqlalchemy-vertica-python"],"connection_string":"vertica+vertica_python://{username}:{password}@{host}/{database}","default_port":5433,"parameters":{"username":"Database username","password":"Database password","host":"localhost, IP address, or hostname (cloud or on-prem)","database":"Database name","port":"Default 5433"},"notes":"Supports load balancer backup host configuration.","docs_url":"http://www.vertica.com/"},"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":34,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":true,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/ydb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/ydb.mdx index 7ea11a19ee8..4e98fd8142b 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/ydb.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/ydb.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.ydb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":false,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":23,"max_score":201,"documentation":{"description":"YDB is a distributed SQL database by Yandex.","logo":"ydb.svg","homepage_url":"https://ydb.tech/","categories":["Traditional RDBMS","Open Source"],"pypi_packages":["ydb-sqlalchemy"],"connection_string":"ydb://{host}:{port}/{database_name}","default_port":2135,"engine_parameters":[{"name":"Protocol","description":"Specify connection protocol (default: grpc)","secure_extra":{"protocol":"grpcs"}}],"authentication_methods":[{"name":"Static Credentials","description":"Username/password authentication","secure_extra":{"credentials":{"username":"...","password":"..."}}},{"name":"Access Token","description":"Token-based authentication","secure_extra":{"credentials":{"token":"..."}}},{"name":"Service Account","description":"Service account JSON credentials","secure_extra":{"credentials":{"service_account_json":{"id":"...","service_account_id":"...","private_key":"..."}}}}],"category":"Other Databases"},"engine":"yql","engine_name":"YDB","engine_aliases":["yql+ydb","ydb"],"default_driver":"ydb","supports_file_upload":false,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"ydb","engine_name":"YDB","module":"ydb","documentation":{"description":"YDB is a distributed SQL database by Yandex.","logo":"ydb.svg","homepage_url":"https://ydb.tech/","categories":["TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["ydb-sqlalchemy"],"connection_string":"ydb://{host}:{port}/{database_name}","default_port":2135,"engine_parameters":[{"name":"Protocol","description":"Specify connection protocol (default: grpc)","secure_extra":{"protocol":"grpcs"}}],"authentication_methods":[{"name":"Static Credentials","description":"Username/password authentication","secure_extra":{"credentials":{"username":"...","password":"..."}}},{"name":"Access Token","description":"Token-based authentication","secure_extra":{"credentials":{"token":"..."}}},{"name":"Service Account","description":"Service account JSON credentials","secure_extra":{"credentials":{"service_account_json":{"id":"...","service_account_id":"...","private_key":"..."}}}}]},"time_grains":{"SECOND":true,"FIVE_SECONDS":false,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"score":23,"max_score":201,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false}; diff --git a/docs/versioned_docs/version-6.1.0/databases/supported/yugabytedb.mdx b/docs/versioned_docs/version-6.1.0/databases/supported/yugabytedb.mdx index 36b56dac527..f758a319a44 100644 --- a/docs/versioned_docs/version-6.1.0/databases/supported/yugabytedb.mdx +++ b/docs/versioned_docs/version-6.1.0/databases/supported/yugabytedb.mdx @@ -26,6 +26,6 @@ under the License. import { DatabasePage } from '@site/src/components/databases'; -export const databaseInfo = {"time_grains":{"SECOND":true,"FIVE_SECONDS":true,"THIRTY_SECONDS":true,"MINUTE":true,"FIVE_MINUTES":true,"TEN_MINUTES":true,"FIFTEEN_MINUTES":true,"THIRTY_MINUTES":true,"HALF_HOUR":false,"HOUR":true,"SIX_HOURS":false,"DAY":true,"WEEK":true,"WEEK_STARTING_SUNDAY":false,"WEEK_STARTING_MONDAY":false,"WEEK_ENDING_SATURDAY":false,"WEEK_ENDING_SUNDAY":false,"MONTH":true,"QUARTER":true,"QUARTER_YEAR":false,"YEAR":true},"module":"superset.db_engine_specs.yugabytedb","limit_method":1,"limit_clause":true,"joins":true,"subqueries":true,"alias_in_select":true,"alias_in_orderby":true,"time_groupby_inline":false,"alias_to_source_column":false,"order_by_not_in_select":true,"expressions_in_orderby":false,"cte_in_subquery":true,"max_column_name":null,"sql_comments":true,"escaped_colons":true,"masked_encrypted_extra":false,"column_type_mapping":false,"function_names":false,"user_impersonation":false,"file_upload":true,"get_extra_table_metadata":false,"dbapi_exception_mapping":false,"custom_errors":false,"dynamic_schema":false,"catalog":false,"dynamic_catalog":false,"ssh_tunneling":true,"query_cancelation":false,"get_metrics":false,"where_latest_partition":false,"expand_data":false,"query_cost_estimation":false,"sql_validation":false,"score":34,"max_score":201,"documentation":{"description":"YugabyteDB is a distributed SQL database built on top of PostgreSQL.","logo":"yugabyte.png","homepage_url":"https://www.yugabyte.com/","categories":["Cloud Data Warehouses","Traditional RDBMS","Open Source"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5433,"notes":"Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.","docs_url":"https://docs.yugabyte.com/","category":"Other Databases"},"engine":"yugabytedb","engine_name":"YugabyteDB","engine_aliases":[],"default_driver":"psycopg2","supports_file_upload":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false}; +export const databaseInfo = {"engine":"yugabytedb","engine_name":"YugabyteDB","module":"yugabytedb","documentation":{"description":"YugabyteDB is a distributed SQL database built on top of PostgreSQL.","logo":"yugabyte.png","homepage_url":"https://www.yugabyte.com/","categories":["CLOUD_DATA_WAREHOUSES","TRADITIONAL_RDBMS","OPEN_SOURCE"],"pypi_packages":["psycopg2"],"connection_string":"postgresql://{username}:{password}@{host}:{port}/{database}","default_port":5433,"notes":"Uses the PostgreSQL driver. psycopg2 comes bundled with Superset.","docs_url":"https://docs.yugabyte.com/"},"time_grains":{},"score":0,"max_score":0,"joins":true,"subqueries":true,"supports_dynamic_schema":false,"supports_catalog":false,"supports_dynamic_catalog":false,"ssh_tunneling":false,"query_cancelation":false,"supports_file_upload":false,"user_impersonation":false,"query_cost_estimation":false,"sql_validation":false};