deploying docs: chore(docs): Spelling (#25453)
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> (apache/superset@041197b6df52c24319cfce32c3052da25b824bc4)
diff --git a/404.html b/404.html
index cfb6ed0..5b00815 100644
--- a/404.html
+++ b/404.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/assets/js/0e9953cd.040c3b57.js b/assets/js/0e9953cd.040c3b57.js
deleted file mode 100644
index 1ea1582..0000000
--- a/assets/js/0e9953cd.040c3b57.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[8015],{88003:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var n=t(83117),o=(t(67294),t(3905));const a={title:"Microsoft SQL Server",hide_title:!0,sidebar_position:30,version:1},s=void 0,i={unversionedId:"databases/sql-server",id:"databases/sql-server",title:"Microsoft SQL Server",description:"SQL Server",source:"@site/docs/databases/sql-server.mdx",sourceDirName:"databases",slug:"/databases/sql-server",permalink:"/docs/databases/sql-server",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/databases/sql-server.mdx",tags:[],version:"current",sidebarPosition:30,frontMatter:{title:"Microsoft SQL Server",hide_title:!0,sidebar_position:30,version:1},sidebar:"tutorialSidebar",previous:{title:"Snowflake",permalink:"/docs/databases/snowflake"},next:{title:"Teradata",permalink:"/docs/databases/teradata"}},c={},l=[{value:"SQL Server",id:"sql-server",level:2}],p={toc:l},d="wrapper";function u(e){let{components:r,...t}=e;return(0,o.kt)(d,(0,n.Z)({},p,t,{components:r,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"sql-server"},"SQL Server"),(0,o.kt)("p",null,"The recommended connector library for SQL Server is ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/pymssql/pymssql"},"pymssql"),"."),(0,o.kt)("p",null,"The connection string for SQL Server looks like this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"mssql+pymssql://<Username>:<Password>@<Host>:<Port-default:1433>/<Database Name>/?Encrypt=yes\n")),(0,o.kt)("p",null,"It is also possible to connect using ",(0,o.kt)("a",{parentName:"p",href:"https://pypi.org/project/pyodbc"},"pyodbc")," with the parameter ",(0,o.kt)("a",{parentName:"p",href:"https://docs.sqlalchemy.org/en/14/dialects/mssql.html#pass-through-exact-pyodbc-string"},"odbc_connect")),(0,o.kt)("p",null,"The connection string for SQL Server looks like this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3Cmy_server%3E%2C1433%3BDatabase%3Dmy_datasbase%3BUid%3Dmy_user_name%3BPwd%3Dmy_password%3BEncrypt%3Dyes%3BConnection+Timeout%3D30\n")))}u.isMDXComponent=!0},3905:(e,r,t)=>{t.d(r,{Zo:()=>p,kt:()=>f});var n=t(67294);function o(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function a(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function s(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?a(Object(t),!0).forEach((function(r){o(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):a(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function i(e,r){if(null==e)return{};var t,n,o=function(e,r){if(null==e)return{};var t,n,o={},a=Object.keys(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||(o[t]=e[t]);return o}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var c=n.createContext({}),l=function(e){var r=n.useContext(c),t=r;return e&&(t="function"==typeof e?e(r):s(s({},r),e)),t},p=function(e){var r=l(e.components);return n.createElement(c.Provider,{value:r},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},m=n.forwardRef((function(e,r){var t=e.components,o=e.mdxType,a=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=l(t),m=o,f=d["".concat(c,".").concat(m)]||d[m]||u[m]||a;return t?n.createElement(f,s(s({ref:r},p),{},{components:t})):n.createElement(f,s({ref:r},p))}));function f(e,r){var t=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var a=t.length,s=new Array(a);s[0]=m;var i={};for(var c in r)hasOwnProperty.call(r,c)&&(i[c]=r[c]);i.originalType=e,i[d]="string"==typeof e?e:o,s[1]=i;for(var l=2;l<a;l++)s[l]=t[l];return n.createElement.apply(null,s)}return n.createElement.apply(null,t)}m.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/0e9953cd.6d25c537.js b/assets/js/0e9953cd.6d25c537.js
new file mode 100644
index 0000000..66919a0
--- /dev/null
+++ b/assets/js/0e9953cd.6d25c537.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[8015],{88003:(e,r,t)=>{t.r(r),t.d(r,{assets:()=>c,contentTitle:()=>s,default:()=>u,frontMatter:()=>a,metadata:()=>i,toc:()=>l});var n=t(83117),o=(t(67294),t(3905));const a={title:"Microsoft SQL Server",hide_title:!0,sidebar_position:30,version:1},s=void 0,i={unversionedId:"databases/sql-server",id:"databases/sql-server",title:"Microsoft SQL Server",description:"SQL Server",source:"@site/docs/databases/sql-server.mdx",sourceDirName:"databases",slug:"/databases/sql-server",permalink:"/docs/databases/sql-server",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/databases/sql-server.mdx",tags:[],version:"current",sidebarPosition:30,frontMatter:{title:"Microsoft SQL Server",hide_title:!0,sidebar_position:30,version:1},sidebar:"tutorialSidebar",previous:{title:"Snowflake",permalink:"/docs/databases/snowflake"},next:{title:"Teradata",permalink:"/docs/databases/teradata"}},c={},l=[{value:"SQL Server",id:"sql-server",level:2}],p={toc:l},d="wrapper";function u(e){let{components:r,...t}=e;return(0,o.kt)(d,(0,n.Z)({},p,t,{components:r,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"sql-server"},"SQL Server"),(0,o.kt)("p",null,"The recommended connector library for SQL Server is ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/pymssql/pymssql"},"pymssql"),"."),(0,o.kt)("p",null,"The connection string for SQL Server looks like this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"mssql+pymssql://<Username>:<Password>@<Host>:<Port-default:1433>/<Database Name>/?Encrypt=yes\n")),(0,o.kt)("p",null,"It is also possible to connect using ",(0,o.kt)("a",{parentName:"p",href:"https://pypi.org/project/pyodbc"},"pyodbc")," with the parameter ",(0,o.kt)("a",{parentName:"p",href:"https://docs.sqlalchemy.org/en/14/dialects/mssql.html#pass-through-exact-pyodbc-string"},"odbc_connect")),(0,o.kt)("p",null,"The connection string for SQL Server looks like this:"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3Cmy_server%3E%2C1433%3BDatabase%3Dmy_database%3BUid%3Dmy_user_name%3BPwd%3Dmy_password%3BEncrypt%3Dyes%3BConnection+Timeout%3D30\n")))}u.isMDXComponent=!0},3905:(e,r,t)=>{t.d(r,{Zo:()=>p,kt:()=>f});var n=t(67294);function o(e,r,t){return r in e?Object.defineProperty(e,r,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[r]=t,e}function a(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);r&&(n=n.filter((function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable}))),t.push.apply(t,n)}return t}function s(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?a(Object(t),!0).forEach((function(r){o(e,r,t[r])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):a(Object(t)).forEach((function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r))}))}return e}function i(e,r){if(null==e)return{};var t,n,o=function(e,r){if(null==e)return{};var t,n,o={},a=Object.keys(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||(o[t]=e[t]);return o}(e,r);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n<a.length;n++)t=a[n],r.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var c=n.createContext({}),l=function(e){var r=n.useContext(c),t=r;return e&&(t="function"==typeof e?e(r):s(s({},r),e)),t},p=function(e){var r=l(e.components);return n.createElement(c.Provider,{value:r},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var r=e.children;return n.createElement(n.Fragment,{},r)}},m=n.forwardRef((function(e,r){var t=e.components,o=e.mdxType,a=e.originalType,c=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=l(t),m=o,f=d["".concat(c,".").concat(m)]||d[m]||u[m]||a;return t?n.createElement(f,s(s({ref:r},p),{},{components:t})):n.createElement(f,s({ref:r},p))}));function f(e,r){var t=arguments,o=r&&r.mdxType;if("string"==typeof e||o){var a=t.length,s=new Array(a);s[0]=m;var i={};for(var c in r)hasOwnProperty.call(r,c)&&(i[c]=r[c]);i.originalType=e,i[d]="string"==typeof e?e:o,s[1]=i;for(var l=2;l<a;l++)s[l]=t[l];return n.createElement.apply(null,s)}return n.createElement.apply(null,t)}m.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/19682bb8.66a691d6.js b/assets/js/19682bb8.66a691d6.js
new file mode 100644
index 0000000..698785f
--- /dev/null
+++ b/assets/js/19682bb8.66a691d6.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[2331],{66390:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=n(83117),a=(n(67294),n(3905));const o={title:"Snowflake",hide_title:!0,sidebar_position:29,version:1},s=void 0,i={unversionedId:"databases/snowflake",id:"databases/snowflake",title:"Snowflake",description:"Snowflake",source:"@site/docs/databases/snowflake.mdx",sourceDirName:"databases",slug:"/databases/snowflake",permalink:"/docs/databases/snowflake",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/databases/snowflake.mdx",tags:[],version:"current",sidebarPosition:29,frontMatter:{title:"Snowflake",hide_title:!0,sidebar_position:29,version:1},sidebar:"tutorialSidebar",previous:{title:"Presto",permalink:"/docs/databases/presto"},next:{title:"Microsoft SQL Server",permalink:"/docs/databases/sql-server"}},l={},c=[{value:"Snowflake",id:"snowflake",level:2},{value:"Install Snowflake Driver",id:"install-snowflake-driver",level:3}],p={toc:c},u="wrapper";function d(e){let{components:t,...n}=e;return(0,a.kt)(u,(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"snowflake"},"Snowflake"),(0,a.kt)("h3",{id:"install-snowflake-driver"},"Install Snowflake Driver"),(0,a.kt)("p",null,"Follow the steps ",(0,a.kt)("a",{parentName:"p",href:"/docs/databases/docker-add-drivers"},"here")," about how to\ninstall new database drivers when setting up Superset locally via docker-compose."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},'echo "snowflake-sqlalchemy" >> ./docker/requirements-local.txt\n')),(0,a.kt)("p",null,"The recommended connector library for Snowflake is\n",(0,a.kt)("a",{parentName:"p",href:"https://pypi.org/project/snowflake-sqlalchemy/"},"snowflake-sqlalchemy"),"."),(0,a.kt)("p",null,"The connection string for Snowflake looks like this:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}\n")),(0,a.kt)("p",null,"The schema is not necessary in the connection string, as it is defined per table/query. The role and\nwarehouse can be omitted if defaults are defined for the user, i.e."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"snowflake://{user}:{password}@{account}.{region}/{database}\n")),(0,a.kt)("p",null,"Make sure the user has privileges to access and use all required\ndatabases/schemas/tables/views/warehouses, as the Snowflake SQLAlchemy engine does not test for\nuser/role rights during engine creation by default. However, when pressing the \u201cTest Connection\u201d\nbutton in the Create or Edit Database dialog, user/role credentials are validated by passing\n\u201cvalidate_default_parameters\u201d: True to the connect() method during engine creation. If the user/role\nis not authorized to access the database, an error is recorded in the Superset logs."),(0,a.kt)("p",null,"And if you want connect Snowflake with ",(0,a.kt)("a",{parentName:"p",href:"https://docs.snowflake.com/en/user-guide/key-pair-auth.html#step-6-configure-the-snowflake-client-to-use-key-pair-authentication"},"Key Pair Authentication"),'.\nPlease make sure you have the key pair and the public key is registered in Snowflake.\nTo connect Snowflake with Key Pair Authentication, you need to add the following parameters to "SECURE EXTRA" field.'),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("em",{parentName:"strong"},"Please note that you need to merge multi-line private key content to one line and insert ",(0,a.kt)("inlineCode",{parentName:"em"},"\\n")," between each line"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},'{\n "auth_method": "keypair",\n "auth_params": {\n "privatekey_body": "-----BEGIN ENCRYPTED PRIVATE KEY-----\\n...\\n...\\n-----END ENCRYPTED PRIVATE KEY-----",\n "privatekey_pass":"Your Private Key Password"\n }\n }\n')),(0,a.kt)("p",null,'If your private key is stored on server, you can replace "privatekey_body" with \u201cprivatekey_path\u201d in parameter.'),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},'{\n "auth_method": "keypair",\n "auth_params": {\n "privatekey_path":"Your Private Key Path",\n "privatekey_pass":"Your Private Key Password"\n }\n}\n')))}d.isMDXComponent=!0},3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>k});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function i(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},o=Object.keys(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),c=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),u=c(n),f=a,k=u["".concat(l,".").concat(f)]||u[f]||d[f]||o;return n?r.createElement(k,s(s({ref:t},p),{},{components:n})):r.createElement(k,s({ref:t},p))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,s=new Array(o);s[0]=f;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[u]="string"==typeof e?e:a,s[1]=i;for(var c=2;c<o;c++)s[c]=n[c];return r.createElement.apply(null,s)}return r.createElement.apply(null,n)}f.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/19682bb8.aed0bf10.js b/assets/js/19682bb8.aed0bf10.js
deleted file mode 100644
index c55d869..0000000
--- a/assets/js/19682bb8.aed0bf10.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[2331],{66390:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>s,default:()=>d,frontMatter:()=>o,metadata:()=>i,toc:()=>c});var r=n(83117),a=(n(67294),n(3905));const o={title:"Snowflake",hide_title:!0,sidebar_position:29,version:1},s=void 0,i={unversionedId:"databases/snowflake",id:"databases/snowflake",title:"Snowflake",description:"Snowflake",source:"@site/docs/databases/snowflake.mdx",sourceDirName:"databases",slug:"/databases/snowflake",permalink:"/docs/databases/snowflake",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/databases/snowflake.mdx",tags:[],version:"current",sidebarPosition:29,frontMatter:{title:"Snowflake",hide_title:!0,sidebar_position:29,version:1},sidebar:"tutorialSidebar",previous:{title:"Presto",permalink:"/docs/databases/presto"},next:{title:"Microsoft SQL Server",permalink:"/docs/databases/sql-server"}},l={},c=[{value:"Snowflake",id:"snowflake",level:2},{value:"Install Snowflake Driver",id:"install-snowflake-driver",level:3}],p={toc:c},u="wrapper";function d(e){let{components:t,...n}=e;return(0,a.kt)(u,(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"snowflake"},"Snowflake"),(0,a.kt)("h3",{id:"install-snowflake-driver"},"Install Snowflake Driver"),(0,a.kt)("p",null,"Follow the steps ",(0,a.kt)("a",{parentName:"p",href:"/docs/databases/docker-add-drivers"},"here")," about how to\ninstall new database drivers when setting up Superset locally via docker-compose."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},'echo "snowflake-sqlalchemy" >> ./docker/requirements-local.txt\n')),(0,a.kt)("p",null,"The recommended connector library for Snowflake is\n",(0,a.kt)("a",{parentName:"p",href:"https://pypi.org/project/snowflake-sqlalchemy/"},"snowflake-sqlalchemy"),"."),(0,a.kt)("p",null,"The connection string for Snowflake looks like this:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"snowflake://{user}:{password}@{account}.{region}/{database}?role={role}&warehouse={warehouse}\n")),(0,a.kt)("p",null,"The schema is not necessary in the connection string, as it is defined per table/query. The role and\nwarehouse can be omitted if defaults are defined for the user, i.e."),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},"snowflake://{user}:{password}@{account}.{region}/{database}\n")),(0,a.kt)("p",null,"Make sure the user has privileges to access and use all required\ndatabases/schemas/tables/views/warehouses, as the Snowflake SQLAlchemy engine does not test for\nuser/role rights during engine creation by default. However, when pressing the \u201cTest Connection\u201d\nbutton in the Create or Edit Database dialog, user/role credentials are validated by passing\n\u201cvalidate_default_parameters\u201d: True to the connect() method during engine creation. If the user/role\nis not authorized to access the database, an error is recorded in the Superset logs."),(0,a.kt)("p",null,"And if you want connect Snowflake with ",(0,a.kt)("a",{parentName:"p",href:"https://docs.snowflake.com/en/user-guide/key-pair-auth.html#step-6-configure-the-snowflake-client-to-use-key-pair-authentication"},"Key Pair Authentication"),'.\nPlase make sure you have the key pair and the public key is registered in Snowflake.\nTo connect Snowflake with Key Pair Authentication, you need to add the following parameters to "SECURE EXTRA" field.'),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},(0,a.kt)("em",{parentName:"strong"},"Please note that you need to merge multi-line private key content to one line and insert ",(0,a.kt)("inlineCode",{parentName:"em"},"\\n")," between each line"))),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},'{\n "auth_method": "keypair",\n "auth_params": {\n "privatekey_body": "-----BEGIN ENCRYPTED PRIVATE KEY-----\\n...\\n...\\n-----END ENCRYPTED PRIVATE KEY-----",\n "privatekey_pass":"Your Private Key Password"\n }\n }\n')),(0,a.kt)("p",null,'If your private key is stored on server, you can replace "privatekey_body" with \u201cprivatekey_path\u201d in parameter.'),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre"},'{\n "auth_method": "keypair",\n "auth_params": {\n "privatekey_path":"Your Private Key Path",\n "privatekey_pass":"Your Private Key Password"\n }\n}\n')))}d.isMDXComponent=!0},3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>k});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function s(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function i(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},o=Object.keys(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),c=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):s(s({},t),e)),n},p=function(e){var t=c(e.components);return r.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),u=c(n),f=a,k=u["".concat(l,".").concat(f)]||u[f]||d[f]||o;return n?r.createElement(k,s(s({ref:t},p),{},{components:n})):r.createElement(k,s({ref:t},p))}));function k(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,s=new Array(o);s[0]=f;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i[u]="string"==typeof e?e:a,s[1]=i;for(var c=2;c<o;c++)s[c]=n[c];return r.createElement.apply(null,s)}return r.createElement.apply(null,n)}f.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/21b4b958.0e4bb161.js b/assets/js/21b4b958.0e4bb161.js
new file mode 100644
index 0000000..a2ee401
--- /dev/null
+++ b/assets/js/21b4b958.0e4bb161.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[3821],{51239:(t,e,a)=>{a.r(e),a.d(e,{assets:()=>m,contentTitle:()=>i,default:()=>o,frontMatter:()=>l,metadata:()=>d,toc:()=>p});var n=a(83117),r=(a(67294),a(3905));const l={title:"Chart Parameters Reference",hide_title:!0,sidebar_position:4,version:1},i=void 0,d={unversionedId:"miscellaneous/chart-params",id:"miscellaneous/chart-params",title:"Chart Parameters Reference",description:"Chart Parameters",source:"@site/docs/miscellaneous/chart-params.mdx",sourceDirName:"miscellaneous",slug:"/miscellaneous/chart-params",permalink:"/docs/miscellaneous/chart-params",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/miscellaneous/chart-params.mdx",tags:[],version:"current",sidebarPosition:4,frontMatter:{title:"Chart Parameters Reference",hide_title:!0,sidebar_position:4,version:1},sidebar:"tutorialSidebar",previous:{title:"Issue Codes",permalink:"/docs/miscellaneous/issue-codes"},next:{title:"Migrating from Legacy to Native Filters",permalink:"/docs/miscellaneous/native-filter-migration"}},m={},p=[{value:"Chart Parameters",id:"chart-parameters",level:2},{value:"Datasource & Chart Type",id:"datasource--chart-type",level:3},{value:"Time",id:"time",level:3},{value:"GROUP BY",id:"group-by",level:3},{value:"NOT GROUPED BY",id:"not-grouped-by",level:3},{value:"Y Axis 1",id:"y-axis-1",level:3},{value:"Y Axis 2",id:"y-axis-2",level:3},{value:"Query",id:"query",level:3},{value:"Chart Options",id:"chart-options",level:3},{value:"Y Axis",id:"y-axis",level:3},{value:"Other",id:"other",level:3},{value:"Unclassified",id:"unclassified",level:3}],N={toc:p},k="wrapper";function o(t){let{components:e,...a}=t;return(0,r.kt)(k,(0,n.Z)({},N,a,{components:e,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"chart-parameters"},"Chart Parameters"),(0,r.kt)("p",null,"Chart parameters are stored as a JSON encoded string in the ",(0,r.kt)("inlineCode",{parentName:"p"},"slices.params")," column and are often referenced throughout the code as form-data. Currently the form-data is neither versioned nor typed as thus is somewhat free-formed. Note in the future there may be merit in using something like ",(0,r.kt)("a",{parentName:"p",href:"https://json-schema.org/"},"JSON Schema")," to both annotate and validate the JSON object in addition to using a Mypy ",(0,r.kt)("inlineCode",{parentName:"p"},"TypedDict")," (introduced in Python 3.8) for typing the form-data in the backend. This section serves as a potential primer for that work."),(0,r.kt)("p",null,"The following tables provide a non-exhaustive list of the various fields which can be present in the JSON object grouped by the Explorer pane sections. These values were obtained by extracting the distinct fields from a legacy deployment consisting of tens of thousands of charts and thus some fields may be missing whilst others may be deprecated."),(0,r.kt)("p",null,"Note not all fields are correctly categorized. The fields vary based on visualization type and may appear in different sections depending on the type. Verified deprecated columns may indicate a missing migration and/or prior migrations which were unsuccessful and thus future work may be required to clean up the form-data."),(0,r.kt)("h3",{id:"datasource--chart-type"},"Datasource & Chart Type"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"database_name")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"Deprecated?"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"datasource")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"<datasource_id>__<datasource_type>"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"datasource_id")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"Deprecated?")," See ",(0,r.kt)("inlineCode",{parentName:"td"},"datasource"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"datasource_name")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"Deprecated?"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"datasource_type")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"Deprecated?")," See ",(0,r.kt)("inlineCode",{parentName:"td"},"datasource"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"viz_type")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Visualization Type")," widget")))),(0,r.kt)("h3",{id:"time"},"Time"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"granularity_sqla")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"The SQLA ",(0,r.kt)("strong",{parentName:"td"},"Time Column")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"time_grain_sqla")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"The SQLA ",(0,r.kt)("strong",{parentName:"td"},"Time Grain")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"time_range")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Time range")," widget")))),(0,r.kt)("h3",{id:"group-by"},"GROUP BY"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"metrics")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"array(string)")),(0,r.kt)("td",{parentName:"tr",align:null},"See Query section")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"order_asc")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"See Query section")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"row_limit")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"See Query section")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"timeseries_limit_metric")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"See Query section")))),(0,r.kt)("h3",{id:"not-grouped-by"},"NOT GROUPED BY"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"order_by_cols")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"array(string)")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Ordering")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"row_limit")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"See Query section")))),(0,r.kt)("h3",{id:"y-axis-1"},"Y Axis 1"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"metric")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Left Axis Metric")," widget. See Query section")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"y_axis_format")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"See Y Axis section")))),(0,r.kt)("h3",{id:"y-axis-2"},"Y Axis 2"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"metric_2")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Right Axis Metric")," widget. See Query section")))),(0,r.kt)("h3",{id:"query"},"Query"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"adhoc_filters")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"array(object)")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Filters")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"extra_filters")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"array(object)")),(0,r.kt)("td",{parentName:"tr",align:null},"Another pathway to the ",(0,r.kt)("strong",{parentName:"td"},"Filters")," widget.",(0,r.kt)("br",null),"It is generally used to pass dashboard filter parameters to a chart.",(0,r.kt)("br",null),"It can be used for appending additional filters to a chart that has been saved with its own filters on an ad-hoc basis if the chart is being used as a standalone widget.",(0,r.kt)("br",null),(0,r.kt)("br",null),"For implementation examples see : ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/apache/superset/blob/66a4c94a1ed542e69fe6399bab4c01d4540486cf/tests/utils_tests.py#L181"},"utils test.py"),(0,r.kt)("br",null),"For insight into how superset processes the contents of this parameter see: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/apache/superset/blob/93c7f5bb446ec6895d7702835f3157426955d5a9/superset-frontend/src/explore/exploreUtils/index.js#L159"},"exploreUtils/index.js"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"columns")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"array(string)")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Breakdowns")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"groupby")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"array(string)")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Group by")," or ",(0,r.kt)("strong",{parentName:"td"},"Series")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"limit")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Series Limit")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"metric"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"metric_2"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"metrics"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"percent_metrics"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"secondary_metric"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"size"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"x"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"y")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string"),",",(0,r.kt)("em",{parentName:"td"},"object"),",",(0,r.kt)("em",{parentName:"td"},"array(string)"),",",(0,r.kt)("em",{parentName:"td"},"array(object)")),(0,r.kt)("td",{parentName:"tr",align:null},"The metric(s) depending on the visualization type")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"order_asc")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Sort Descending")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"row_limit")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Row limit")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"timeseries_limit_metric")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"object")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Sort By")," widget")))),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"metric")," (or equivalent) and ",(0,r.kt)("inlineCode",{parentName:"p"},"timeseries_limit_metric")," fields are all composed of either metric names or the JSON representation of the ",(0,r.kt)("inlineCode",{parentName:"p"},"AdhocMetric")," TypeScript type. The ",(0,r.kt)("inlineCode",{parentName:"p"},"adhoc_filters")," is composed of the JSON represent of the ",(0,r.kt)("inlineCode",{parentName:"p"},"AdhocFilter")," TypeScript type (which can comprise of columns or metrics depending on whether it is a WHERE or HAVING clause). The ",(0,r.kt)("inlineCode",{parentName:"p"},"all_columns"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"all_columns_x"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"columns"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"groupby"),", and ",(0,r.kt)("inlineCode",{parentName:"p"},"order_by_cols")," fields all represent column names."),(0,r.kt)("h3",{id:"chart-options"},"Chart Options"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"color_picker")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"object")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Fixed Color")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"label_colors")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"object")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Color Scheme")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"normalized")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Normalized")," widget")))),(0,r.kt)("h3",{id:"y-axis"},"Y Axis"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"y_axis_2_label")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"Deprecated?"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"y_axis_format")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Y Axis Format")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"y_axis_zero")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"Deprecated?"))))),(0,r.kt)("p",null,"Note the ",(0,r.kt)("inlineCode",{parentName:"p"},"y_axis_format")," is defined under various section for some charts."),(0,r.kt)("h3",{id:"other"},"Other"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"color_scheme")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null})))),(0,r.kt)("h3",{id:"unclassified"},"Unclassified"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"add_to_dash")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"code")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"collapsed_fieldsets")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"comparison type")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"country_fieldtype")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"default_filters")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"entity")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"expanded_slices")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"filter_immune_slice_fields")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"filter_immune_slices")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"flt_col_0")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"flt_col_1")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"flt_eq_0")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"flt_eq_1")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"flt_op_0")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"flt_op_1")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"goto_dash")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"import_time")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"label")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"linear_color_scheme")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"new_dashboard_name")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"new_slice_name")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"num_period_compare")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"period_ratio_type")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"perm")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"rdo_save")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"refresh_frequency")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"remote_id")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"resample_fillmethod")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"resample_how")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"rose_area_proportion")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"save_to_dashboard_id")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"schema")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"series")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"show_bubbles")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"slice_name")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"timed_refresh_immune_slices")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"userid")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})))))}o.isMDXComponent=!0},3905:(t,e,a)=>{a.d(e,{Zo:()=>N,kt:()=>s});var n=a(67294);function r(t,e,a){return e in t?Object.defineProperty(t,e,{value:a,enumerable:!0,configurable:!0,writable:!0}):t[e]=a,t}function l(t,e){var a=Object.keys(t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);e&&(n=n.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),a.push.apply(a,n)}return a}function i(t){for(var e=1;e<arguments.length;e++){var a=null!=arguments[e]?arguments[e]:{};e%2?l(Object(a),!0).forEach((function(e){r(t,e,a[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(a)):l(Object(a)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(a,e))}))}return t}function d(t,e){if(null==t)return{};var a,n,r=function(t,e){if(null==t)return{};var a,n,r={},l=Object.keys(t);for(n=0;n<l.length;n++)a=l[n],e.indexOf(a)>=0||(r[a]=t[a]);return r}(t,e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);for(n=0;n<l.length;n++)a=l[n],e.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(r[a]=t[a])}return r}var m=n.createContext({}),p=function(t){var e=n.useContext(m),a=e;return t&&(a="function"==typeof t?t(e):i(i({},e),t)),a},N=function(t){var e=p(t.components);return n.createElement(m.Provider,{value:e},t.children)},k="mdxType",o={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},u=n.forwardRef((function(t,e){var a=t.components,r=t.mdxType,l=t.originalType,m=t.parentName,N=d(t,["components","mdxType","originalType","parentName"]),k=p(a),u=r,s=k["".concat(m,".").concat(u)]||k[u]||o[u]||l;return a?n.createElement(s,i(i({ref:e},N),{},{components:a})):n.createElement(s,i({ref:e},N))}));function s(t,e){var a=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var l=a.length,i=new Array(l);i[0]=u;var d={};for(var m in e)hasOwnProperty.call(e,m)&&(d[m]=e[m]);d.originalType=t,d[k]="string"==typeof t?t:r,i[1]=d;for(var p=2;p<l;p++)i[p]=a[p];return n.createElement.apply(null,i)}return n.createElement.apply(null,a)}u.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/21b4b958.84b9f6be.js b/assets/js/21b4b958.84b9f6be.js
deleted file mode 100644
index 5f0b6b8..0000000
--- a/assets/js/21b4b958.84b9f6be.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[3821],{51239:(t,e,a)=>{a.r(e),a.d(e,{assets:()=>m,contentTitle:()=>i,default:()=>o,frontMatter:()=>l,metadata:()=>d,toc:()=>p});var n=a(83117),r=(a(67294),a(3905));const l={title:"Chart Parameters Reference",hide_title:!0,sidebar_position:4,version:1},i=void 0,d={unversionedId:"miscellaneous/chart-params",id:"miscellaneous/chart-params",title:"Chart Parameters Reference",description:"Chart Parameters",source:"@site/docs/miscellaneous/chart-params.mdx",sourceDirName:"miscellaneous",slug:"/miscellaneous/chart-params",permalink:"/docs/miscellaneous/chart-params",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/miscellaneous/chart-params.mdx",tags:[],version:"current",sidebarPosition:4,frontMatter:{title:"Chart Parameters Reference",hide_title:!0,sidebar_position:4,version:1},sidebar:"tutorialSidebar",previous:{title:"Issue Codes",permalink:"/docs/miscellaneous/issue-codes"},next:{title:"Migrating from Legacy to Native Filters",permalink:"/docs/miscellaneous/native-filter-migration"}},m={},p=[{value:"Chart Parameters",id:"chart-parameters",level:2},{value:"Datasource & Chart Type",id:"datasource--chart-type",level:3},{value:"Time",id:"time",level:3},{value:"GROUP BY",id:"group-by",level:3},{value:"NOT GROUPED BY",id:"not-grouped-by",level:3},{value:"Y Axis 1",id:"y-axis-1",level:3},{value:"Y Axis 2",id:"y-axis-2",level:3},{value:"Query",id:"query",level:3},{value:"Chart Options",id:"chart-options",level:3},{value:"Y Axis",id:"y-axis",level:3},{value:"Other",id:"other",level:3},{value:"Unclassified",id:"unclassified",level:3}],N={toc:p},k="wrapper";function o(t){let{components:e,...a}=t;return(0,r.kt)(k,(0,n.Z)({},N,a,{components:e,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"chart-parameters"},"Chart Parameters"),(0,r.kt)("p",null,"Chart parameters are stored as a JSON encoded string in the ",(0,r.kt)("inlineCode",{parentName:"p"},"slices.params")," column and are often referenced throughout the code as form-data. Currently the form-data is neither versioned nor typed as thus is somewhat free-formed. Note in the future there may be merit in using something like ",(0,r.kt)("a",{parentName:"p",href:"https://json-schema.org/"},"JSON Schema")," to both annotate and validate the JSON object in addition to using a Mypy ",(0,r.kt)("inlineCode",{parentName:"p"},"TypedDict")," (introduced in Python 3.8) for typing the form-data in the backend. This section serves as a potential primer for that work."),(0,r.kt)("p",null,"The following tables provide a non-exhaustive list of the various fields which can be present in the JSON object grouped by the Explorer pane sections. These values were obtained by extracting the distinct fields from a legacy deployment consisting of tens of thousands of charts and thus some fields may be missing whilst others may be deprecated."),(0,r.kt)("p",null,"Note not all fields are correctly categorized. The fields vary based on visualization type and may appear in different sections depending on the type. Verified deprecated columns may indicate a missing migration and/or prior migrations which were unsuccessful and thus future work may be required to clean up the form-data."),(0,r.kt)("h3",{id:"datasource--chart-type"},"Datasource & Chart Type"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"database_name")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"Deprecated?"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"datasource")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"<datasouce_id>__<datasource_type>"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"datasource_id")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"Deprecated?")," See ",(0,r.kt)("inlineCode",{parentName:"td"},"datasource"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"datasource_name")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"Deprecated?"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"datasource_type")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"Deprecated?")," See ",(0,r.kt)("inlineCode",{parentName:"td"},"datasource"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"viz_type")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Visualization Type")," widget")))),(0,r.kt)("h3",{id:"time"},"Time"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"granularity_sqla")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"The SQLA ",(0,r.kt)("strong",{parentName:"td"},"Time Column")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"time_grain_sqla")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"The SQLA ",(0,r.kt)("strong",{parentName:"td"},"Time Grain")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"time_range")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Time range")," widget")))),(0,r.kt)("h3",{id:"group-by"},"GROUP BY"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"metrics")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"array(string)")),(0,r.kt)("td",{parentName:"tr",align:null},"See Query section")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"order_asc")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"See Query section")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"row_limit")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"See Query section")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"timeseries_limit_metric")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"See Query section")))),(0,r.kt)("h3",{id:"not-grouped-by"},"NOT GROUPED BY"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"order_by_cols")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"array(string)")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Ordering")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"row_limit")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"See Query section")))),(0,r.kt)("h3",{id:"y-axis-1"},"Y Axis 1"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"metric")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Left Axis Metric")," widget. See Query section")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"y_axis_format")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"See Y Axis section")))),(0,r.kt)("h3",{id:"y-axis-2"},"Y Axis 2"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"metric_2")),(0,r.kt)("td",{parentName:"tr",align:null},"-"),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Right Axis Metric")," widget. See Query section")))),(0,r.kt)("h3",{id:"query"},"Query"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"adhoc_filters")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"array(object)")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Filters")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"extra_filters")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"array(object)")),(0,r.kt)("td",{parentName:"tr",align:null},"Another pathway to the ",(0,r.kt)("strong",{parentName:"td"},"Filters")," widget.",(0,r.kt)("br",null),"It is generally used to pass dashboard filter parameters to a chart.",(0,r.kt)("br",null),"It can be used for appending additional filters to a chart that has been saved with its own filters on an ad-hoc basis if the chart is being used as a standalone widget.",(0,r.kt)("br",null),(0,r.kt)("br",null),"For implementation examples see : ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/apache/superset/blob/66a4c94a1ed542e69fe6399bab4c01d4540486cf/tests/utils_tests.py#L181"},"utils test.py"),(0,r.kt)("br",null),"For insight into how superset processes the contents of this parameter see: ",(0,r.kt)("a",{parentName:"td",href:"https://github.com/apache/superset/blob/93c7f5bb446ec6895d7702835f3157426955d5a9/superset-frontend/src/explore/exploreUtils/index.js#L159"},"exploreUtils/index.js"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"columns")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"array(string)")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Breakdowns")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"groupby")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"array(string)")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Group by")," or ",(0,r.kt)("strong",{parentName:"td"},"Series")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"limit")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Series Limit")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"metric"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"metric_2"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"metrics"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"percent_metrics"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"secondary_metric"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"size"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"x"),(0,r.kt)("br",null),(0,r.kt)("inlineCode",{parentName:"td"},"y")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string"),",",(0,r.kt)("em",{parentName:"td"},"object"),",",(0,r.kt)("em",{parentName:"td"},"array(string)"),",",(0,r.kt)("em",{parentName:"td"},"array(object)")),(0,r.kt)("td",{parentName:"tr",align:null},"The metric(s) depending on the visualization type")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"order_asc")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Sort Descending")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"row_limit")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"number")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Row limit")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"timeseries_limit_metric")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"object")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Sort By")," widget")))),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"metric")," (or equivalent) and ",(0,r.kt)("inlineCode",{parentName:"p"},"timeseries_limit_metric")," fields are all composed of either metric names or the JSON representation of the ",(0,r.kt)("inlineCode",{parentName:"p"},"AdhocMetric")," TypeScript type. The ",(0,r.kt)("inlineCode",{parentName:"p"},"adhoc_filters")," is composed of the JSON represent of the ",(0,r.kt)("inlineCode",{parentName:"p"},"AdhocFilter")," TypeScript type (which can comprise of columns or metrics depending on whether it is a WHERE or HAVING clause). The ",(0,r.kt)("inlineCode",{parentName:"p"},"all_columns"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"all_columns_x"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"columns"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"groupby"),", and ",(0,r.kt)("inlineCode",{parentName:"p"},"order_by_cols")," fields all represent column names."),(0,r.kt)("h3",{id:"chart-options"},"Chart Options"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"color_picker")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"object")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Fixed Color")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"label_colors")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"object")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Color Scheme")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"normalized")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"boolean")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Normalized")," widget")))),(0,r.kt)("h3",{id:"y-axis"},"Y Axis"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"y_axis_2_label")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"Deprecated?"))),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"y_axis_format")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null},"The ",(0,r.kt)("strong",{parentName:"td"},"Y Axis Format")," widget")),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"y_axis_zero")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"Deprecated?"))))),(0,r.kt)("p",null,"Note the ",(0,r.kt)("inlineCode",{parentName:"p"},"y_axis_format")," is defined under various section for some charts."),(0,r.kt)("h3",{id:"other"},"Other"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"color_scheme")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"string")),(0,r.kt)("td",{parentName:"tr",align:null})))),(0,r.kt)("h3",{id:"unclassified"},"Unclassified"),(0,r.kt)("table",null,(0,r.kt)("thead",{parentName:"table"},(0,r.kt)("tr",{parentName:"thead"},(0,r.kt)("th",{parentName:"tr",align:null},"Field"),(0,r.kt)("th",{parentName:"tr",align:null},"Type"),(0,r.kt)("th",{parentName:"tr",align:null},"Notes"))),(0,r.kt)("tbody",{parentName:"table"},(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"add_to_dash")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"code")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"collapsed_fieldsets")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"comparison type")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"country_fieldtype")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"default_filters")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"entity")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"expanded_slices")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"filter_immune_slice_fields")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"filter_immune_slices")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"flt_col_0")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"flt_col_1")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"flt_eq_0")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"flt_eq_1")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"flt_op_0")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"flt_op_1")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"goto_dash")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"import_time")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"label")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"linear_color_scheme")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"new_dashboard_name")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"new_slice_name")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"num_period_compare")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"period_ratio_type")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"perm")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"rdo_save")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"refresh_frequency")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"remote_id")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"resample_fillmethod")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"resample_how")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"rose_area_proportion")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"save_to_dashboard_id")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"schema")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"series")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"show_bubbles")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"slice_name")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"timed_refresh_immune_slices")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})),(0,r.kt)("tr",{parentName:"tbody"},(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("inlineCode",{parentName:"td"},"userid")),(0,r.kt)("td",{parentName:"tr",align:null},(0,r.kt)("em",{parentName:"td"},"N/A")),(0,r.kt)("td",{parentName:"tr",align:null})))))}o.isMDXComponent=!0},3905:(t,e,a)=>{a.d(e,{Zo:()=>N,kt:()=>s});var n=a(67294);function r(t,e,a){return e in t?Object.defineProperty(t,e,{value:a,enumerable:!0,configurable:!0,writable:!0}):t[e]=a,t}function l(t,e){var a=Object.keys(t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);e&&(n=n.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),a.push.apply(a,n)}return a}function i(t){for(var e=1;e<arguments.length;e++){var a=null!=arguments[e]?arguments[e]:{};e%2?l(Object(a),!0).forEach((function(e){r(t,e,a[e])})):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(a)):l(Object(a)).forEach((function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(a,e))}))}return t}function d(t,e){if(null==t)return{};var a,n,r=function(t,e){if(null==t)return{};var a,n,r={},l=Object.keys(t);for(n=0;n<l.length;n++)a=l[n],e.indexOf(a)>=0||(r[a]=t[a]);return r}(t,e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);for(n=0;n<l.length;n++)a=l[n],e.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(r[a]=t[a])}return r}var m=n.createContext({}),p=function(t){var e=n.useContext(m),a=e;return t&&(a="function"==typeof t?t(e):i(i({},e),t)),a},N=function(t){var e=p(t.components);return n.createElement(m.Provider,{value:e},t.children)},k="mdxType",o={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},u=n.forwardRef((function(t,e){var a=t.components,r=t.mdxType,l=t.originalType,m=t.parentName,N=d(t,["components","mdxType","originalType","parentName"]),k=p(a),u=r,s=k["".concat(m,".").concat(u)]||k[u]||o[u]||l;return a?n.createElement(s,i(i({ref:e},N),{},{components:a})):n.createElement(s,i({ref:e},N))}));function s(t,e){var a=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var l=a.length,i=new Array(l);i[0]=u;var d={};for(var m in e)hasOwnProperty.call(e,m)&&(d[m]=e[m]);d.originalType=t,d[k]="string"==typeof t?t:r,i[1]=d;for(var p=2;p<l;p++)i[p]=a[p];return n.createElement.apply(null,i)}return n.createElement.apply(null,a)}u.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/2461ffa2.b19d6100.js b/assets/js/2461ffa2.226a14e2.js
similarity index 99%
rename from assets/js/2461ffa2.b19d6100.js
rename to assets/js/2461ffa2.226a14e2.js
index 1b3e2c0..cf32b3d 100644
--- a/assets/js/2461ffa2.b19d6100.js
+++ b/assets/js/2461ffa2.226a14e2.js
@@ -1 +1 @@
-(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[7600],{58623:(e,t,s)=>{"use strict";s.r(t),s.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>g,frontMatter:()=>c,metadata:()=>m,toc:()=>u});var r=s(83117),a=(s(67294),s(3905)),n=s(48764),o=s(31156);const i=JSON.parse('{"components":{"responses":{"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Not found"},"410":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"error_type":{"enum":["FRONTEND_CSRF_ERROR","FRONTEND_NETWORK_ERROR","FRONTEND_TIMEOUT_ERROR","GENERIC_DB_ENGINE_ERROR","COLUMN_DOES_NOT_EXIST_ERROR","TABLE_DOES_NOT_EXIST_ERROR","SCHEMA_DOES_NOT_EXIST_ERROR","CONNECTION_INVALID_USERNAME_ERROR","CONNECTION_INVALID_PASSWORD_ERROR","CONNECTION_INVALID_HOSTNAME_ERROR","CONNECTION_PORT_CLOSED_ERROR","CONNECTION_INVALID_PORT_ERROR","CONNECTION_HOST_DOWN_ERROR","CONNECTION_ACCESS_DENIED_ERROR","CONNECTION_UNKNOWN_DATABASE_ERROR","CONNECTION_DATABASE_PERMISSIONS_ERROR","CONNECTION_MISSING_PARAMETERS_ERROR","OBJECT_DOES_NOT_EXIST_ERROR","SYNTAX_ERROR","CONNECTION_DATABASE_TIMEOUT","VIZ_GET_DF_ERROR","UNKNOWN_DATASOURCE_TYPE_ERROR","FAILED_FETCHING_DATASOURCE_INFO_ERROR","TABLE_SECURITY_ACCESS_ERROR","DATASOURCE_SECURITY_ACCESS_ERROR","DATABASE_SECURITY_ACCESS_ERROR","QUERY_SECURITY_ACCESS_ERROR","MISSING_OWNERSHIP_ERROR","USER_ACTIVITY_SECURITY_ACCESS_ERROR","BACKEND_TIMEOUT_ERROR","DATABASE_NOT_FOUND_ERROR","MISSING_TEMPLATE_PARAMS_ERROR","INVALID_TEMPLATE_PARAMS_ERROR","RESULTS_BACKEND_NOT_CONFIGURED_ERROR","DML_NOT_ALLOWED_ERROR","INVALID_CTAS_QUERY_ERROR","INVALID_CVAS_QUERY_ERROR","SQLLAB_TIMEOUT_ERROR","RESULTS_BACKEND_ERROR","ASYNC_WORKERS_ERROR","ADHOC_SUBQUERY_NOT_ALLOWED_ERROR","GENERIC_COMMAND_ERROR","GENERIC_BACKEND_ERROR","INVALID_PAYLOAD_FORMAT_ERROR","INVALID_PAYLOAD_SCHEMA_ERROR","REPORT_NOTIFICATION_ERROR"],"type":"string"},"extra":{"type":"object"},"level":{"enum":["info","warning","error"],"type":"string"},"message":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Gone"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Fatal error"}},"schemas":{"AdvancedDataTypeSchema":{"properties":{"display_value":{"description":"The string representation of the parsed values","type":"string"},"error_message":{"type":"string"},"valid_filter_operators":{"items":{"type":"string"},"type":"array"},"values":{"items":{"description":"parsed value (can be any value)","type":"string"},"type":"array"}},"type":"object"},"AnnotationLayer":{"properties":{"annotationType":{"description":"Type of annotation layer","enum":["FORMULA","INTERVAL","EVENT","TIME_SERIES"],"type":"string"},"color":{"description":"Layer color","nullable":true,"type":"string"},"descriptionColumns":{"description":"Columns to use as the description. If none are provided, all will be shown.","items":{"type":"string"},"type":"array"},"hideLine":{"description":"Should line be hidden. Only applies to line annotations","nullable":true,"type":"boolean"},"intervalEndColumn":{"description":"Column containing end of interval. Only applies to interval layers","nullable":true,"type":"string"},"name":{"description":"Name of layer","type":"string"},"opacity":{"description":"Opacity of layer","enum":["","opacityLow","opacityMedium","opacityHigh"],"nullable":true,"type":"string"},"overrides":{"additionalProperties":{"nullable":true},"description":"which properties should be overridable","nullable":true,"type":"object"},"show":{"description":"Should the layer be shown","type":"boolean"},"showLabel":{"description":"Should the label always be shown","nullable":true,"type":"boolean"},"showMarkers":{"description":"Should markers be shown. Only applies to line annotations.","type":"boolean"},"sourceType":{"description":"Type of source for annotation data","enum":["","line","NATIVE","table"],"type":"string"},"style":{"description":"Line style. Only applies to time-series annotations","enum":["dashed","dotted","solid","longDashed"],"type":"string"},"timeColumn":{"description":"Column with event date or interval start date","nullable":true,"type":"string"},"titleColumn":{"description":"Column with title","nullable":true,"type":"string"},"value":{"description":"For formula annotations, this contains the formula. For other types, this is the primary key of the source object."},"width":{"description":"Width of annotation line","minimum":0,"type":"number"}},"required":["name","show","showMarkers","value"],"type":"object"},"AnnotationLayerRestApi.get":{"properties":{"descr":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"AnnotationLayerRestApi.get_list":{"properties":{"changed_by":{"$ref":"#/components/schemas/AnnotationLayerRestApi.get_list.User1"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/AnnotationLayerRestApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"descr":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"AnnotationLayerRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"AnnotationLayerRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"AnnotationLayerRestApi.post":{"properties":{"descr":{"description":"Give a description for this annotation layer","nullable":true,"type":"string"},"name":{"description":"The annotation layer name","maxLength":250,"minLength":1,"type":"string"}},"required":["name"],"type":"object"},"AnnotationLayerRestApi.put":{"properties":{"descr":{"description":"Give a description for this annotation layer","type":"string"},"name":{"description":"The annotation layer name","maxLength":250,"minLength":1,"type":"string"}},"type":"object"},"AnnotationRestApi.get":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"},"layer":{"$ref":"#/components/schemas/AnnotationRestApi.get.AnnotationLayer"},"long_descr":{"nullable":true,"type":"string"},"short_descr":{"maxLength":500,"nullable":true,"type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"}},"required":["layer"],"type":"object"},"AnnotationRestApi.get.AnnotationLayer":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"AnnotationRestApi.get_list":{"properties":{"changed_by":{"$ref":"#/components/schemas/AnnotationRestApi.get_list.User1"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/AnnotationRestApi.get_list.User"},"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"long_descr":{"nullable":true,"type":"string"},"short_descr":{"maxLength":500,"nullable":true,"type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"}},"type":"object"},"AnnotationRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object"},"AnnotationRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object"},"AnnotationRestApi.post":{"properties":{"end_dttm":{"description":"The annotation end date time","format":"date-time","type":"string"},"json_metadata":{"description":"JSON metadata","nullable":true,"type":"string"},"long_descr":{"description":"A long description","nullable":true,"type":"string"},"short_descr":{"description":"A short description","maxLength":500,"minLength":1,"type":"string"},"start_dttm":{"description":"The annotation start date time","format":"date-time","type":"string"}},"required":["end_dttm","short_descr","start_dttm"],"type":"object"},"AnnotationRestApi.put":{"properties":{"end_dttm":{"description":"The annotation end date time","format":"date-time","type":"string"},"json_metadata":{"description":"JSON metadata","nullable":true,"type":"string"},"long_descr":{"description":"A long description","nullable":true,"type":"string"},"short_descr":{"description":"A short description","maxLength":500,"minLength":1,"type":"string"},"start_dttm":{"description":"The annotation start date time","format":"date-time","type":"string"}},"type":"object"},"AvailableDomainsSchema":{"properties":{"domains":{"items":{"type":"string"},"type":"array"}},"type":"object"},"CacheInvalidationRequestSchema":{"properties":{"datasource_uids":{"description":"The uid of the dataset/datasource this new chart will use. A complete datasource identification needs `datasouce_uid` ","items":{"type":"string"},"type":"array"},"datasources":{"description":"A list of the data source and database names","items":{"$ref":"#/components/schemas/Datasource"},"type":"array"}},"type":"object"},"CacheRestApi.get":{"properties":{"id":{"type":"integer"}},"type":"object"},"CacheRestApi.get_list":{"properties":{"id":{"type":"integer"}},"type":"object"},"CacheRestApi.post":{"properties":{"id":{"type":"integer"}},"type":"object"},"CacheRestApi.put":{"properties":{"id":{"type":"integer"}},"type":"object"},"ChartCacheScreenshotResponseSchema":{"properties":{"cache_key":{"description":"The cache key","type":"string"},"chart_url":{"description":"The url to render the chart","type":"string"},"image_url":{"description":"The url to fetch the screenshot","type":"string"}},"type":"object"},"ChartCacheWarmUpRequestSchema":{"properties":{"chart_id":{"description":"The ID of the chart to warm up cache for","type":"integer"},"dashboard_id":{"description":"The ID of the dashboard to get filters for when warming cache","type":"integer"},"extra_filters":{"description":"Extra filters to apply when warming up cache","type":"string"}},"required":["chart_id"],"type":"object"},"ChartCacheWarmUpResponseSchema":{"properties":{"result":{"description":"A list of each chart\'s warmup status and errors if any","items":{"$ref":"#/components/schemas/ChartCacheWarmUpResponseSingle"},"type":"array"}},"type":"object"},"ChartCacheWarmUpResponseSingle":{"properties":{"chart_id":{"description":"The ID of the chart the status belongs to","type":"integer"},"viz_error":{"description":"Error that occurred when warming cache for chart","type":"string"},"viz_status":{"description":"Status of the underlying query for the viz","type":"string"}},"type":"object"},"ChartDataAdhocMetricSchema":{"properties":{"aggregate":{"description":"Aggregation operator.Only required for simple expression types.","enum":["AVG","COUNT","COUNT_DISTINCT","MAX","MIN","SUM"],"type":"string"},"column":{"$ref":"#/components/schemas/ChartDataColumn"},"expressionType":{"description":"Simple or SQL metric","enum":["SIMPLE","SQL"],"example":"SQL","type":"string"},"hasCustomLabel":{"description":"When false, the label will be automatically generated based on the aggregate expression. When true, a custom label has to be specified.","example":true,"type":"boolean"},"isExtra":{"description":"Indicates if the filter has been added by a filter component as opposed to being a part of the original query.","type":"boolean"},"label":{"description":"Label for the metric. Is automatically generated unlesshasCustomLabel is true, in which case label must be defined.","example":"Weighted observations","type":"string"},"optionName":{"description":"Unique identifier. Can be any string value, as long as all metrics have a unique identifier. If undefined, a random namewill be generated.","example":"metric_aec60732-fac0-4b17-b736-93f1a5c93e30","type":"string"},"sqlExpression":{"description":"The metric as defined by a SQL aggregate expression. Only required for SQL expression type.","example":"SUM(weight * observations) / SUM(weight)","type":"string"},"timeGrain":{"description":"Optional time grain for temporal filters","example":"PT1M","type":"string"}},"required":["expressionType"],"type":"object"},"ChartDataAggregateOptionsSchema":{"properties":{"aggregates":{"description":"The keys are the name of the aggregate column to be created, and the values specify the details of how to apply the aggregation. If an operator requires additional options, these can be passed here to be unpacked in the operator call. The following numpy operators are supported: average, argmin, argmax, cumsum, cumprod, max, mean, median, nansum, nanmin, nanmax, nanmean, nanmedian, min, percentile, prod, product, std, sum, var. Any options required by the operator can be passed to the `options` object.\\n\\nIn the example, a new column `first_quantile` is created based on values in the column `my_col` using the `percentile` operator with the `q=0.25` parameter.","example":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"type":"object"}},"type":"object"},"ChartDataAsyncResponseSchema":{"properties":{"channel_id":{"description":"Unique session async channel ID","type":"string"},"job_id":{"description":"Unique async job ID","type":"string"},"result_url":{"description":"Unique result URL for fetching async query data","type":"string"},"status":{"description":"Status value for async job","type":"string"},"user_id":{"description":"Requesting user ID","nullable":true,"type":"string"}},"type":"object"},"ChartDataBoxplotOptionsSchema":{"properties":{"groupby":{"items":{"description":"Columns by which to group the query.","type":"string"},"nullable":true,"type":"array"},"metrics":{"description":"Aggregate expressions. Metrics can be passed as both references to datasource metrics (strings), or ad-hoc metricswhich are defined only within the query object. See `ChartDataAdhocMetricSchema` for the structure of ad-hoc metrics. When metrics is undefined or null, the query is executed without a groupby. However, when metrics is an array (length >= 0), a groupby clause is added to the query.","items":{},"nullable":true,"type":"array"},"percentiles":{"description":"Upper and lower percentiles for percentile whisker type.","example":[1,99]},"whisker_type":{"description":"Whisker type. Any numpy function will work.","enum":["tukey","min/max","percentile"],"example":"tukey","type":"string"}},"required":["whisker_type"],"type":"object"},"ChartDataColumn":{"properties":{"column_name":{"description":"The name of the target column","example":"mycol","type":"string"},"type":{"description":"Type of target column","example":"BIGINT","type":"string"}},"type":"object"},"ChartDataContributionOptionsSchema":{"properties":{"orientation":{"description":"Should cell values be calculated across the row or column.","enum":["row","column"],"example":"row","type":"string"}},"required":["orientation"],"type":"object"},"ChartDataDatasource":{"properties":{"id":{"description":"Datasource id","type":"integer"},"type":{"description":"Datasource type","enum":["sl_table","table","dataset","query","saved_query","view"],"type":"string"}},"required":["id"],"type":"object"},"ChartDataExtras":{"properties":{"having":{"description":"HAVING clause to be added to aggregate queries using AND operator.","type":"string"},"relative_end":{"description":"End time for relative time deltas. Default: `config[\\"DEFAULT_RELATIVE_START_TIME\\"]`","enum":["today","now"],"type":"string"},"relative_start":{"description":"Start time for relative time deltas. Default: `config[\\"DEFAULT_RELATIVE_START_TIME\\"]`","enum":["today","now"],"type":"string"},"time_grain_sqla":{"description":"To what level of granularity should the temporal column be aggregated. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.","enum":["PT1S","PT5S","PT30S","PT1M","PT5M","PT10M","PT15M","PT30M","PT1H","PT6H","P1D","P1W","P1M","P3M","P1Y","1969-12-28T00:00:00Z/P1W","1969-12-29T00:00:00Z/P1W","P1W/1970-01-03T00:00:00Z","P1W/1970-01-04T00:00:00Z","PT2H","PT4H","PT8H","PT10H","PT12H"],"example":"P1D","nullable":true,"type":"string"},"where":{"description":"WHERE clause to be added to queries using AND operator.","type":"string"}},"type":"object"},"ChartDataFilter":{"properties":{"col":{"description":"The column to filter by. Can be either a string (physical or saved expression) or an object (adhoc column)","example":"country"},"grain":{"description":"Optional time grain for temporal filters","example":"PT1M","type":"string"},"isExtra":{"description":"Indicates if the filter has been added by a filter component as opposed to being a part of the original query.","type":"boolean"},"op":{"description":"The comparison operator.","enum":["==","!=",">","<",">=","<=","LIKE","ILIKE","IS NULL","IS NOT NULL","IN","NOT IN","IS TRUE","IS FALSE","TEMPORAL_RANGE"],"example":"IN","type":"string"},"val":{"description":"The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.","example":["China","France","Japan"],"nullable":true}},"required":["col","op"],"type":"object"},"ChartDataGeodeticParseOptionsSchema":{"properties":{"altitude":{"description":"Name of target column for decoded altitude. If omitted, altitude information in geodetic string is ignored.","type":"string"},"geodetic":{"description":"Name of source column containing geodetic point strings","type":"string"},"latitude":{"description":"Name of target column for decoded latitude","type":"string"},"longitude":{"description":"Name of target column for decoded longitude","type":"string"}},"required":["geodetic","latitude","longitude"],"type":"object"},"ChartDataGeohashDecodeOptionsSchema":{"properties":{"geohash":{"description":"Name of source column containing geohash string","type":"string"},"latitude":{"description":"Name of target column for decoded latitude","type":"string"},"longitude":{"description":"Name of target column for decoded longitude","type":"string"}},"required":["geohash","latitude","longitude"],"type":"object"},"ChartDataGeohashEncodeOptionsSchema":{"properties":{"geohash":{"description":"Name of target column for encoded geohash string","type":"string"},"latitude":{"description":"Name of source latitude column","type":"string"},"longitude":{"description":"Name of source longitude column","type":"string"}},"required":["geohash","latitude","longitude"],"type":"object"},"ChartDataPivotOptionsSchema":{"properties":{"aggregates":{"description":"The keys are the name of the aggregate column to be created, and the values specify the details of how to apply the aggregation. If an operator requires additional options, these can be passed here to be unpacked in the operator call. The following numpy operators are supported: average, argmin, argmax, cumsum, cumprod, max, mean, median, nansum, nanmin, nanmax, nanmean, nanmedian, min, percentile, prod, product, std, sum, var. Any options required by the operator can be passed to the `options` object.\\n\\nIn the example, a new column `first_quantile` is created based on values in the column `my_col` using the `percentile` operator with the `q=0.25` parameter.","example":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"type":"object"},"column_fill_value":{"description":"Value to replace missing pivot columns names with.","type":"string"},"columns":{"description":"Columns to group by on the table columns","items":{"type":"string"},"type":"array"},"drop_missing_columns":{"description":"Do not include columns whose entries are all missing (default: `true`).","type":"boolean"},"marginal_distribution_name":{"description":"Name of marginal distribution row/column. (default: `All`)","type":"string"},"marginal_distributions":{"description":"Add totals for row/column. (default: `false`)","type":"boolean"},"metric_fill_value":{"description":"Value to replace missing values with in aggregate calculations.","type":"number"}},"type":"object"},"ChartDataPostProcessingOperation":{"properties":{"operation":{"description":"Post processing operation type","enum":["aggregate","boxplot","compare","contribution","cum","diff","escape_separator","flatten","geodetic_parse","geohash_decode","geohash_encode","pivot","prophet","rename","resample","rolling","select","sort","unescape_separator"],"example":"aggregate","type":"string"},"options":{"description":"Options specifying how to perform the operation. Please refer to the respective post processing operation option schemas. For example, `ChartDataPostProcessingOperationOptions` specifies the required options for the pivot operation.","example":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]},"type":"object"}},"required":["operation"],"type":"object"},"ChartDataProphetOptionsSchema":{"properties":{"confidence_interval":{"description":"Width of predicted confidence interval","example":0.8,"maximum":1,"minimum":0,"type":"number"},"monthly_seasonality":{"description":"Should monthly seasonality be applied. An integer value will specify Fourier order of seasonality, `None` will automatically detect seasonality.","example":false},"periods":{"description":"Time periods (in units of `time_grain`) to predict into the future","example":7,"type":"integer"},"time_grain":{"description":"Time grain used to specify time period increments in prediction. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.","enum":["PT1S","PT5S","PT30S","PT1M","PT5M","PT10M","PT15M","PT30M","PT1H","PT6H","P1D","P1W","P1M","P3M","P1Y","1969-12-28T00:00:00Z/P1W","1969-12-29T00:00:00Z/P1W","P1W/1970-01-03T00:00:00Z","P1W/1970-01-04T00:00:00Z","PT2H","PT4H","PT8H","PT10H","PT12H"],"example":"P1D","type":"string"},"weekly_seasonality":{"description":"Should weekly seasonality be applied. An integer value will specify Fourier order of seasonality, `None` will automatically detect seasonality.","example":false},"yearly_seasonality":{"description":"Should yearly seasonality be applied. An integer value will specify Fourier order of seasonality, `None` will automatically detect seasonality.","example":false}},"required":["confidence_interval","periods","time_grain"],"type":"object"},"ChartDataQueryContextSchema":{"properties":{"custom_cache_timeout":{"description":"Override the default cache timeout","nullable":true,"type":"integer"},"datasource":{"$ref":"#/components/schemas/ChartDataDatasource"},"force":{"description":"Should the queries be forced to load from the source. Default: `false`","nullable":true,"type":"boolean"},"form_data":{"nullable":true},"queries":{"items":{"$ref":"#/components/schemas/ChartDataQueryObject"},"type":"array"},"result_format":{"enum":["csv","json","xlsx"]},"result_type":{"enum":["columns","full","query","results","samples","timegrains","post_processed","drill_detail"]}},"type":"object"},"ChartDataQueryObject":{"properties":{"annotation_layers":{"description":"Annotation layers to apply to chart","items":{"$ref":"#/components/schemas/AnnotationLayer"},"nullable":true,"type":"array"},"applied_time_extras":{"description":"A mapping of temporal extras that have been applied to the query","example":{"__time_range":"1 year ago : now"},"nullable":true,"type":"object"},"apply_fetch_values_predicate":{"description":"Add fetch values predicate (where clause) to query if defined in datasource","nullable":true,"type":"boolean"},"columns":{"description":"Columns which to select in the query.","items":{},"nullable":true,"type":"array"},"datasource":{"allOf":[{"$ref":"#/components/schemas/ChartDataDatasource"}],"nullable":true},"extras":{"allOf":[{"$ref":"#/components/schemas/ChartDataExtras"}],"description":"Extra parameters to add to the query.","nullable":true},"filters":{"items":{"$ref":"#/components/schemas/ChartDataFilter"},"nullable":true,"type":"array"},"granularity":{"description":"Name of temporal column used for time filtering. ","nullable":true,"type":"string"},"granularity_sqla":{"deprecated":true,"description":"Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use `granularity` instead.","nullable":true,"type":"string"},"groupby":{"description":"Columns by which to group the query. This field is deprecated, use `columns` instead.","items":{},"nullable":true,"type":"array"},"having":{"deprecated":true,"description":"HAVING clause to be added to aggregate queries using AND operator. This field is deprecated and should be passed to `extras`.","nullable":true,"type":"string"},"is_rowcount":{"description":"Should the rowcount of the actual query be returned","nullable":true,"type":"boolean"},"is_timeseries":{"description":"Is the `query_object` a timeseries.","nullable":true,"type":"boolean"},"metrics":{"description":"Aggregate expressions. Metrics can be passed as both references to datasource metrics (strings), or ad-hoc metricswhich are defined only within the query object. See `ChartDataAdhocMetricSchema` for the structure of ad-hoc metrics.","items":{},"nullable":true,"type":"array"},"order_desc":{"description":"Reverse order. Default: `false`","nullable":true,"type":"boolean"},"orderby":{"description":"Expects a list of lists where the first element is the column name which to sort by, and the second element is a boolean.","example":[["my_col_1",false],["my_col_2",true]],"items":{},"nullable":true,"type":"array"},"post_processing":{"description":"Post processing operations to be applied to the result set. Operations are applied to the result set in sequential order.","items":{"allOf":[{"$ref":"#/components/schemas/ChartDataPostProcessingOperation"}],"nullable":true},"nullable":true,"type":"array"},"result_type":{"enum":["columns","full","query","results","samples","timegrains","post_processed","drill_detail"],"nullable":true},"row_limit":{"description":"Maximum row count (0=disabled). Default: `config[\\"ROW_LIMIT\\"]`","minimum":0,"nullable":true,"type":"integer"},"row_offset":{"description":"Number of rows to skip. Default: `0`","minimum":0,"nullable":true,"type":"integer"},"series_columns":{"description":"Columns to use when limiting series count. All columns must be present in the `columns` property. Requires `series_limit` and `series_limit_metric` to be set.","items":{},"nullable":true,"type":"array"},"series_limit":{"description":"Maximum number of series. Requires `series` and `series_limit_metric` to be set.","nullable":true,"type":"integer"},"series_limit_metric":{"description":"Metric used to limit timeseries queries by. Requires `series` and `series_limit` to be set.","nullable":true},"time_offsets":{"items":{"type":"string"},"nullable":true,"type":"array"},"time_range":{"description":"A time rage, either expressed as a colon separated string `since : until` or human readable freeform. Valid formats for `since` and `until` are: \\n- ISO 8601\\n- X days/years/hours/day/year/weeks\\n- X days/years/hours/day/year/weeks ago\\n- X days/years/hours/day/year/weeks from now\\n\\nAdditionally, the following freeform can be used:\\n\\n- Last day\\n- Last week\\n- Last month\\n- Last quarter\\n- Last year\\n- No filter\\n- Last X seconds/minutes/hours/days/weeks/months/years\\n- Next X seconds/minutes/hours/days/weeks/months/years\\n","example":"Last week","nullable":true,"type":"string"},"time_shift":{"description":"A human-readable date/time string. Please refer to [parsdatetime](https://github.com/bear/parsedatetime) documentation for details on valid values.","nullable":true,"type":"string"},"timeseries_limit":{"description":"Maximum row count for timeseries queries. This field is deprecated, use `series_limit` instead.Default: `0`","nullable":true,"type":"integer"},"timeseries_limit_metric":{"description":"Metric used to limit timeseries queries by. This field is deprecated, use `series_limit_metric` instead.","nullable":true},"url_params":{"additionalProperties":{"description":"The value of the query parameter","type":"string"},"description":"Optional query parameters passed to a dashboard or Explore view","nullable":true,"type":"object"},"where":{"deprecated":true,"description":"WHERE clause to be added to queries using AND operator.This field is deprecated and should be passed to `extras`.","nullable":true,"type":"string"}},"type":"object"},"ChartDataResponseResult":{"properties":{"annotation_data":{"description":"All requested annotation data","items":{"additionalProperties":{"type":"string"},"type":"object"},"nullable":true,"type":"array"},"applied_filters":{"description":"A list with applied filters","items":{"type":"object"},"type":"array"},"cache_key":{"description":"Unique cache key for query object","nullable":true,"type":"string"},"cache_timeout":{"description":"Cache timeout in following order: custom timeout, datasource timeout, cache default timeout, config default cache timeout.","nullable":true,"type":"integer"},"cached_dttm":{"description":"Cache timestamp","nullable":true,"type":"string"},"colnames":{"description":"A list of column names","items":{"type":"string"},"type":"array"},"coltypes":{"description":"A list of generic data types of each column","items":{"type":"integer"},"type":"array"},"data":{"description":"A list with results","items":{"type":"object"},"type":"array"},"error":{"description":"Error","nullable":true,"type":"string"},"from_dttm":{"description":"Start timestamp of time range","nullable":true,"type":"integer"},"is_cached":{"description":"Is the result cached","type":"boolean"},"query":{"description":"The executed query statement","type":"string"},"rejected_filters":{"description":"A list with rejected filters","items":{"type":"object"},"type":"array"},"rowcount":{"description":"Amount of rows in result set","type":"integer"},"stacktrace":{"description":"Stacktrace if there was an error","nullable":true,"type":"string"},"status":{"description":"Status of the query","enum":["stopped","failed","pending","running","scheduled","success","timed_out"],"type":"string"},"to_dttm":{"description":"End timestamp of time range","nullable":true,"type":"integer"}},"required":["cache_key","cache_timeout","cached_dttm","is_cached","query"],"type":"object"},"ChartDataResponseSchema":{"properties":{"result":{"description":"A list of results for each corresponding query in the request.","items":{"$ref":"#/components/schemas/ChartDataResponseResult"},"type":"array"}},"type":"object"},"ChartDataRestApi.get":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"dashboards":{"$ref":"#/components/schemas/ChartDataRestApi.get.Dashboard"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"owners":{"$ref":"#/components/schemas/ChartDataRestApi.get.User"},"params":{"nullable":true,"type":"string"},"query_context":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"tags":{"$ref":"#/components/schemas/ChartDataRestApi.get.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"ChartDataRestApi.get.Dashboard":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"}},"type":"object"},"ChartDataRestApi.get.Tag":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"ChartDataRestApi.get.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartDataRestApi.get_list":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_by":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.User3"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_dttm":{"readOnly":true},"changed_on_utc":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.User"},"created_by_name":{"readOnly":true},"created_on_delta_humanized":{"readOnly":true},"dashboards":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.Dashboard"},"datasource_id":{"nullable":true,"type":"integer"},"datasource_name_text":{"readOnly":true},"datasource_type":{"maxLength":200,"nullable":true,"type":"string"},"datasource_url":{"readOnly":true},"description":{"nullable":true,"type":"string"},"description_markeddown":{"readOnly":true},"edit_url":{"readOnly":true},"form_data":{"readOnly":true},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"last_saved_at":{"format":"date-time","nullable":true,"type":"string"},"last_saved_by":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.User2"},"owners":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.User1"},"params":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"slice_url":{"readOnly":true},"table":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.SqlaTable"},"tags":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"ChartDataRestApi.get_list.Dashboard":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object"},"ChartDataRestApi.get_list.SqlaTable":{"properties":{"default_endpoint":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"}},"required":["table_name"],"type":"object"},"ChartDataRestApi.get_list.Tag":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"ChartDataRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartDataRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartDataRestApi.get_list.User2":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartDataRestApi.get_list.User3":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartDataRestApi.post":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasouce_id` and `datasource_type`.","type":"integer"},"datasource_name":{"description":"The datasource name.","nullable":true,"type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["sl_table","table","dataset","query","saved_query","view"],"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"type":"string"},"query_context_generation":{"description":"The query context generation represents whether the query_contextis user generated or not so that it does not update user modfiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":1,"type":"string"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"type":"string"}},"required":["datasource_id","datasource_type","slice_name"],"type":"object"},"ChartDataRestApi.put":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasouce_id` and `datasource_type`.","nullable":true,"type":"integer"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["sl_table","table","dataset","query","saved_query","view"],"nullable":true,"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"type":"string"},"query_context_generation":{"description":"The query context generation represents whether the query_contextis user generated or not so that it does not update user modfiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ChartDataRollingOptionsSchema":{"properties":{"center":{"description":"Should the label be at the center of the window.Default: `false`","example":false,"type":"boolean"},"min_periods":{"description":"The minimum amount of periods required for a row to be included in the result set.","example":7,"type":"integer"},"rolling_type":{"description":"Type of rolling window. Any numpy function will work.","enum":["average","argmin","argmax","cumsum","cumprod","max","mean","median","nansum","nanmin","nanmax","nanmean","nanmedian","nanpercentile","min","percentile","prod","product","std","sum","var"],"example":"percentile","type":"string"},"rolling_type_options":{"description":"Optional options to pass to rolling method. Needed for e.g. quantile operation.","example":{},"type":"object"},"win_type":{"description":"Type of window function. See [SciPy window functions](https://docs.scipy.org/doc/scipy/reference /signal.windows.html#module-scipy.signal.windows) for more details. Some window functions require passing additional parameters to `rolling_type_options`. For instance, to use `gaussian`, the parameter `std` needs to be provided.","enum":["boxcar","triang","blackman","hamming","bartlett","parzen","bohman","blackmanharris","nuttall","barthann","kaiser","gaussian","general_gaussian","slepian","exponential"],"type":"string"},"window":{"description":"Size of the rolling window in days.","example":7,"type":"integer"}},"required":["rolling_type","window"],"type":"object"},"ChartDataSelectOptionsSchema":{"properties":{"columns":{"description":"Columns which to select from the input data, in the desired order. If columns are renamed, the original column name should be referenced here.","example":["country","gender","age"],"items":{"type":"string"},"type":"array"},"exclude":{"description":"Columns to exclude from selection.","example":["my_temp_column"],"items":{"type":"string"},"type":"array"},"rename":{"description":"columns which to rename, mapping source column to target column. For instance, `{\'y\': \'y2\'}` will rename the column `y` to `y2`.","example":[{"age":"average_age"}],"items":{"type":"object"},"type":"array"}},"type":"object"},"ChartDataSortOptionsSchema":{"properties":{"aggregates":{"description":"The keys are the name of the aggregate column to be created, and the values specify the details of how to apply the aggregation. If an operator requires additional options, these can be passed here to be unpacked in the operator call. The following numpy operators are supported: average, argmin, argmax, cumsum, cumprod, max, mean, median, nansum, nanmin, nanmax, nanmean, nanmedian, min, percentile, prod, product, std, sum, var. Any options required by the operator can be passed to the `options` object.\\n\\nIn the example, a new column `first_quantile` is created based on values in the column `my_col` using the `percentile` operator with the `q=0.25` parameter.","example":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"type":"object"},"columns":{"description":"columns by by which to sort. The key specifies the column name, value specifies if sorting in ascending order.","example":{"country":true,"gender":false},"type":"object"}},"required":["columns"],"type":"object"},"ChartEntityResponseSchema":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","type":"integer"},"certification_details":{"description":"Details of the certification","type":"string"},"certified_by":{"description":"Person or group that has certified this chart","type":"string"},"changed_on":{"description":"The ISO date that the chart was last changed.","format":"date-time","type":"string"},"description":{"description":"A description of the chart propose.","type":"string"},"description_markeddown":{"description":"Sanitized HTML version of the chart description.","type":"string"},"form_data":{"description":"Form data from the Explore controls used to form the chart\'s data query.","type":"object"},"id":{"description":"The id of the chart.","type":"integer"},"slice_name":{"description":"The name of the chart.","type":"string"},"slice_url":{"description":"The URL of the chart.","type":"string"}},"type":"object"},"ChartFavStarResponseResult":{"properties":{"id":{"description":"The Chart id","type":"integer"},"value":{"description":"The FaveStar value","type":"boolean"}},"type":"object"},"ChartGetDatasourceObjectDataResponse":{"properties":{"datasource_id":{"description":"The datasource identifier","type":"integer"},"datasource_type":{"description":"The datasource type","type":"integer"}},"type":"object"},"ChartGetDatasourceObjectResponse":{"properties":{"label":{"description":"The name of the datasource","type":"string"},"value":{"$ref":"#/components/schemas/ChartGetDatasourceObjectDataResponse"}},"type":"object"},"ChartGetDatasourceResponseSchema":{"properties":{"count":{"description":"The total number of datasources","type":"integer"},"result":{"$ref":"#/components/schemas/ChartGetDatasourceObjectResponse"}},"type":"object"},"ChartRestApi.get":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"dashboards":{"$ref":"#/components/schemas/ChartRestApi.get.Dashboard"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"owners":{"$ref":"#/components/schemas/ChartRestApi.get.User"},"params":{"nullable":true,"type":"string"},"query_context":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"tags":{"$ref":"#/components/schemas/ChartRestApi.get.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"ChartRestApi.get.Dashboard":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"}},"type":"object"},"ChartRestApi.get.Tag":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"ChartRestApi.get.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartRestApi.get_list":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_by":{"$ref":"#/components/schemas/ChartRestApi.get_list.User3"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_dttm":{"readOnly":true},"changed_on_utc":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/ChartRestApi.get_list.User"},"created_by_name":{"readOnly":true},"created_on_delta_humanized":{"readOnly":true},"dashboards":{"$ref":"#/components/schemas/ChartRestApi.get_list.Dashboard"},"datasource_id":{"nullable":true,"type":"integer"},"datasource_name_text":{"readOnly":true},"datasource_type":{"maxLength":200,"nullable":true,"type":"string"},"datasource_url":{"readOnly":true},"description":{"nullable":true,"type":"string"},"description_markeddown":{"readOnly":true},"edit_url":{"readOnly":true},"form_data":{"readOnly":true},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"last_saved_at":{"format":"date-time","nullable":true,"type":"string"},"last_saved_by":{"$ref":"#/components/schemas/ChartRestApi.get_list.User2"},"owners":{"$ref":"#/components/schemas/ChartRestApi.get_list.User1"},"params":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"slice_url":{"readOnly":true},"table":{"$ref":"#/components/schemas/ChartRestApi.get_list.SqlaTable"},"tags":{"$ref":"#/components/schemas/ChartRestApi.get_list.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"ChartRestApi.get_list.Dashboard":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object"},"ChartRestApi.get_list.SqlaTable":{"properties":{"default_endpoint":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"}},"required":["table_name"],"type":"object"},"ChartRestApi.get_list.Tag":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"ChartRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartRestApi.get_list.User2":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartRestApi.get_list.User3":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartRestApi.post":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasouce_id` and `datasource_type`.","type":"integer"},"datasource_name":{"description":"The datasource name.","nullable":true,"type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["sl_table","table","dataset","query","saved_query","view"],"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"type":"string"},"query_context_generation":{"description":"The query context generation represents whether the query_contextis user generated or not so that it does not update user modfiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":1,"type":"string"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"type":"string"}},"required":["datasource_id","datasource_type","slice_name"],"type":"object"},"ChartRestApi.put":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasouce_id` and `datasource_type`.","nullable":true,"type":"integer"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["sl_table","table","dataset","query","saved_query","view"],"nullable":true,"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"type":"string"},"query_context_generation":{"description":"The query context generation represents whether the query_contextis user generated or not so that it does not update user modfiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"CssTemplateRestApi.get":{"properties":{"created_by":{"$ref":"#/components/schemas/CssTemplateRestApi.get.User"},"css":{"nullable":true,"type":"string"},"id":{"type":"integer"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"CssTemplateRestApi.get.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"CssTemplateRestApi.get_list":{"properties":{"changed_by":{"$ref":"#/components/schemas/CssTemplateRestApi.get_list.User1"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/CssTemplateRestApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"css":{"nullable":true,"type":"string"},"id":{"type":"integer"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"CssTemplateRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"CssTemplateRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"CssTemplateRestApi.post":{"properties":{"css":{"nullable":true,"type":"string"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"CssTemplateRestApi.put":{"properties":{"css":{"nullable":true,"type":"string"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"DashboardCopySchema":{"properties":{"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","maxLength":500,"minLength":0,"nullable":true,"type":"string"},"duplicate_slices":{"description":"Whether or not to also copy all charts on the dashboard","type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","type":"string"}},"required":["json_metadata"],"type":"object"},"DashboardDatasetSchema":{"properties":{"cache_timeout":{"type":"integer"},"column_formats":{"type":"object"},"column_types":{"items":{"type":"integer"},"type":"array"},"columns":{"items":{"type":"object"},"type":"array"},"currency_formats":{"type":"object"},"database":{"$ref":"#/components/schemas/Database"},"datasource_name":{"type":"string"},"default_endpoint":{"type":"string"},"edit_url":{"type":"string"},"fetch_values_predicate":{"type":"string"},"filter_select":{"type":"boolean"},"filter_select_enabled":{"type":"boolean"},"granularity_sqla":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"health_check_message":{"type":"string"},"id":{"type":"integer"},"is_sqllab_view":{"type":"boolean"},"main_dttm_col":{"type":"string"},"metrics":{"items":{"type":"object"},"type":"array"},"name":{"type":"string"},"offset":{"type":"integer"},"order_by_choices":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"owners":{"items":{"type":"object"},"type":"array"},"params":{"type":"string"},"perm":{"type":"string"},"schema":{"type":"string"},"select_star":{"type":"string"},"sql":{"type":"string"},"table_name":{"type":"string"},"template_params":{"type":"string"},"time_grain_sqla":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"type":{"type":"string"},"uid":{"type":"string"},"verbose_map":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object"},"DashboardGetResponseSchema":{"properties":{"certification_details":{"description":"Details of the certification","type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard","type":"string"},"changed_by":{"$ref":"#/components/schemas/User"},"changed_by_name":{"type":"string"},"changed_on":{"format":"date-time","type":"string"},"changed_on_delta_humanized":{"type":"string"},"charts":{"items":{"description":"The names of the dashboard\'s charts. Names are used for legacy reasons.","type":"string"},"type":"array"},"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","type":"string"},"id":{"type":"integer"},"is_managed_externally":{"nullable":true,"type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","type":"string"},"owners":{"items":{"$ref":"#/components/schemas/User"},"type":"array"},"position_json":{"description":"This json object describes the positioning of the widgets in the dashboard. It is dynamically generated when adjusting the widgets size and positions by using drag & drop in the dashboard view","type":"string"},"published":{"type":"boolean"},"roles":{"items":{"$ref":"#/components/schemas/Roles"},"type":"array"},"slug":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/Tag1"},"type":"array"},"thumbnail_url":{"type":"string"},"url":{"type":"string"}},"type":"object"},"DashboardPermalinkStateSchema":{"properties":{"activeTabs":{"description":"Current active dashboard tabs","items":{"type":"string"},"nullable":true,"type":"array"},"anchor":{"description":"Optional anchor link added to url hash","nullable":true,"type":"string"},"dataMask":{"description":"Data mask used for native filter state","nullable":true,"type":"object"},"urlParams":{"description":"URL Parameters","items":{"description":"URL Parameter key-value pair","nullable":true},"nullable":true,"type":"array"}},"type":"object"},"DashboardRestApi.get":{"properties":{"id":{"type":"integer"}},"type":"object"},"DashboardRestApi.get_list":{"properties":{"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_by":{"$ref":"#/components/schemas/DashboardRestApi.get_list.User2"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_utc":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/DashboardRestApi.get_list.User"},"created_on_delta_humanized":{"readOnly":true},"css":{"nullable":true,"type":"string"},"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"json_metadata":{"nullable":true,"type":"string"},"owners":{"$ref":"#/components/schemas/DashboardRestApi.get_list.User1"},"position_json":{"nullable":true,"type":"string"},"published":{"nullable":true,"type":"boolean"},"roles":{"$ref":"#/components/schemas/DashboardRestApi.get_list.Role"},"slug":{"maxLength":255,"nullable":true,"type":"string"},"status":{"readOnly":true},"tags":{"$ref":"#/components/schemas/DashboardRestApi.get_list.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true}},"type":"object"},"DashboardRestApi.get_list.Role":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object"},"DashboardRestApi.get_list.Tag":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"DashboardRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DashboardRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DashboardRestApi.get_list.User2":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DashboardRestApi.post":{"properties":{"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard","nullable":true,"type":"string"},"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","maxLength":500,"minLength":0,"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this dashboard. If left empty you will be one of the owners of the dashboard.","type":"integer"},"type":"array"},"position_json":{"description":"This json object describes the positioning of the widgets in the dashboard. It is dynamically generated when adjusting the widgets size and positions by using drag & drop in the dashboard view","type":"string"},"published":{"description":"Determines whether or not this dashboard is visible in the list of all dashboards.","type":"boolean"},"roles":{"items":{"description":"Roles is a list which defines access to the dashboard. These roles are always applied in addition to restrictions on dataset level access. If no roles defined then the dashboard is available to all roles.","type":"integer"},"type":"array"},"slug":{"description":"Unique identifying part for the web address of the dashboard.","maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"DashboardRestApi.put":{"properties":{"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard","nullable":true,"type":"string"},"css":{"description":"Override CSS for the dashboard.","nullable":true,"type":"string"},"dashboard_title":{"description":"A title for the dashboard.","maxLength":500,"minLength":0,"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this dashboard. If left empty you will be one of the owners of the dashboard.","nullable":true,"type":"integer"},"type":"array"},"position_json":{"description":"This json object describes the positioning of the widgets in the dashboard. It is dynamically generated when adjusting the widgets size and positions by using drag & drop in the dashboard view","nullable":true,"type":"string"},"published":{"description":"Determines whether or not this dashboard is visible in the list of all dashboards.","nullable":true,"type":"boolean"},"roles":{"items":{"description":"Roles is a list which defines access to the dashboard. These roles are always applied in addition to restrictions on dataset level access. If no roles defined then the dashboard is available to all roles.","nullable":true,"type":"integer"},"type":"array"},"slug":{"description":"Unique identifying part for the web address of the dashboard.","maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"Database":{"properties":{"allows_cost_estimate":{"type":"boolean"},"allows_subquery":{"type":"boolean"},"allows_virtual_table_explore":{"type":"boolean"},"backend":{"type":"string"},"disable_data_preview":{"type":"boolean"},"explore_database_id":{"type":"integer"},"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"Database1":{"properties":{"database_name":{"type":"string"}},"type":"object"},"DatabaseConnectionSchema":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"backend":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","type":"string"},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine_information":{"additionalProperties":{},"type":"object"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"extra":{"description":"<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\\" rel=\\"noopener noreferrer\\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\\" rel=\\"noopener noreferrer\\">sqlalchemy.MetaData</a> call.<br>2. The <code>metadata_cache_timeout</code> is a cache timeout setting in seconds for metadata fetch of this database. Specify it as <strong>\\"metadata_cache_timeout\\": {\\"schema_cache_timeout\\": 600, \\"table_cache_timeout\\": 600}</strong>. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.<br>3. The <code>schemas_allowed_for_file_upload</code> is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as <strong>\\"schemas_allowed_for_file_upload\\": [\\"public\\", \\"csv_upload\\"]</strong>. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty<br>4. The <code>version</code> field is a string specifying the this db\'s version. This should be used with Presto DBs so that the syntax is correct<br>5. The <code>allows_virtual_table_explore</code> field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.<br>6. The <code>disable_data_preview</code> field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.</p>","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"id":{"description":"Database ID (for updates)","type":"integer"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.<br/>If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"<p>JSON string containing additional connection configuration.<br>This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.</p>","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"parameters_schema":{"additionalProperties":{},"description":"JSONSchema for configuring the database by parameters instead of SQLAlchemy URI","type":"object"},"server_cert":{"description":"<p>Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.</p>","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"<p>Refer to the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_2/core/engines.html#database-urls\\" rel=\\"noopener noreferrer\\">SqlAlchemy docs</a> for more information on how to structure your URI.</p>","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"$ref":"#/components/schemas/DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"type":"object"},"DatabaseFunctionNamesResponse":{"properties":{"function_names":{"items":{"type":"string"},"type":"array"}},"type":"object"},"DatabaseRelatedChart":{"properties":{"id":{"type":"integer"},"slice_name":{"type":"string"},"viz_type":{"type":"string"}},"type":"object"},"DatabaseRelatedCharts":{"properties":{"count":{"description":"Chart count","type":"integer"},"result":{"description":"A list of dashboards","items":{"$ref":"#/components/schemas/DatabaseRelatedChart"},"type":"array"}},"type":"object"},"DatabaseRelatedDashboard":{"properties":{"id":{"type":"integer"},"json_metadata":{"type":"object"},"slug":{"type":"string"},"title":{"type":"string"}},"type":"object"},"DatabaseRelatedDashboards":{"properties":{"count":{"description":"Dashboard count","type":"integer"},"result":{"description":"A list of dashboards","items":{"$ref":"#/components/schemas/DatabaseRelatedDashboard"},"type":"array"}},"type":"object"},"DatabaseRelatedObjectsResponse":{"properties":{"charts":{"$ref":"#/components/schemas/DatabaseRelatedCharts"},"dashboards":{"$ref":"#/components/schemas/DatabaseRelatedDashboards"}},"type":"object"},"DatabaseRestApi.get":{"properties":{"allow_ctas":{"nullable":true,"type":"boolean"},"allow_cvas":{"nullable":true,"type":"boolean"},"allow_dml":{"nullable":true,"type":"boolean"},"allow_file_upload":{"nullable":true,"type":"boolean"},"allow_run_async":{"nullable":true,"type":"boolean"},"backend":{"readOnly":true},"cache_timeout":{"nullable":true,"type":"integer"},"configuration_method":{"maxLength":255,"nullable":true,"type":"string"},"database_name":{"maxLength":250,"type":"string"},"driver":{"readOnly":true},"engine_information":{"readOnly":true},"expose_in_sqllab":{"nullable":true,"type":"boolean"},"force_ctas_schema":{"maxLength":250,"nullable":true,"type":"string"},"id":{"type":"integer"},"impersonate_user":{"nullable":true,"type":"boolean"},"is_managed_externally":{"type":"boolean"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["database_name"],"type":"object"},"DatabaseRestApi.get_list":{"properties":{"allow_ctas":{"nullable":true,"type":"boolean"},"allow_cvas":{"nullable":true,"type":"boolean"},"allow_dml":{"nullable":true,"type":"boolean"},"allow_file_upload":{"nullable":true,"type":"boolean"},"allow_run_async":{"nullable":true,"type":"boolean"},"allows_cost_estimate":{"readOnly":true},"allows_subquery":{"readOnly":true},"allows_virtual_table_explore":{"readOnly":true},"backend":{"readOnly":true},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/DatabaseRestApi.get_list.User"},"database_name":{"maxLength":250,"type":"string"},"disable_data_preview":{"readOnly":true},"engine_information":{"readOnly":true},"explore_database_id":{"readOnly":true},"expose_in_sqllab":{"nullable":true,"type":"boolean"},"extra":{"nullable":true,"type":"string"},"force_ctas_schema":{"maxLength":250,"nullable":true,"type":"string"},"id":{"type":"integer"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["database_name"],"type":"object"},"DatabaseRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DatabaseRestApi.post":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"description":"<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\\" rel=\\"noopener noreferrer\\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\\" rel=\\"noopener noreferrer\\">sqlalchemy.MetaData</a> call.<br>2. The <code>metadata_cache_timeout</code> is a cache timeout setting in seconds for metadata fetch of this database. Specify it as <strong>\\"metadata_cache_timeout\\": {\\"schema_cache_timeout\\": 600, \\"table_cache_timeout\\": 600}</strong>. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.<br>3. The <code>schemas_allowed_for_file_upload</code> is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as <strong>\\"schemas_allowed_for_file_upload\\": [\\"public\\", \\"csv_upload\\"]</strong>. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty<br>4. The <code>version</code> field is a string specifying the this db\'s version. This should be used with Presto DBs so that the syntax is correct<br>5. The <code>allows_virtual_table_explore</code> field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.<br>6. The <code>disable_data_preview</code> field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.</p>","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.<br/>If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"<p>JSON string containing additional connection configuration.<br>This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.</p>","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"<p>Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.</p>","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"<p>Refer to the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_2/core/engines.html#database-urls\\" rel=\\"noopener noreferrer\\">SqlAlchemy docs</a> for more information on how to structure your URI.</p>","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"$ref":"#/components/schemas/DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"required":["database_name"],"type":"object"},"DatabaseRestApi.put":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"description":"<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\\" rel=\\"noopener noreferrer\\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\\" rel=\\"noopener noreferrer\\">sqlalchemy.MetaData</a> call.<br>2. The <code>metadata_cache_timeout</code> is a cache timeout setting in seconds for metadata fetch of this database. Specify it as <strong>\\"metadata_cache_timeout\\": {\\"schema_cache_timeout\\": 600, \\"table_cache_timeout\\": 600}</strong>. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.<br>3. The <code>schemas_allowed_for_file_upload</code> is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as <strong>\\"schemas_allowed_for_file_upload\\": [\\"public\\", \\"csv_upload\\"]</strong>. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty<br>4. The <code>version</code> field is a string specifying the this db\'s version. This should be used with Presto DBs so that the syntax is correct<br>5. The <code>allows_virtual_table_explore</code> field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.<br>6. The <code>disable_data_preview</code> field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.</p>","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.<br/>If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"<p>JSON string containing additional connection configuration.<br>This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.</p>","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"<p>Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.</p>","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"<p>Refer to the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_2/core/engines.html#database-urls\\" rel=\\"noopener noreferrer\\">SqlAlchemy docs</a> for more information on how to structure your URI.</p>","maxLength":1024,"minLength":0,"type":"string"},"ssh_tunnel":{"allOf":[{"$ref":"#/components/schemas/DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"type":"object"},"DatabaseSSHTunnel":{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object"},"DatabaseSchemaAccessForFileUploadResponse":{"properties":{"schemas":{"description":"The list of schemas allowed for the database to upload information","items":{"type":"string"},"type":"array"}},"type":"object"},"DatabaseTablesResponse":{"properties":{"extra":{"description":"Extra data used to specify column metadata","type":"object"},"type":{"description":"table or view","type":"string"},"value":{"description":"The table or view name","type":"string"}},"type":"object"},"DatabaseTestConnectionSchema":{"properties":{"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"extra":{"description":"<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\\" rel=\\"noopener noreferrer\\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\\" rel=\\"noopener noreferrer\\">sqlalchemy.MetaData</a> call.<br>2. The <code>metadata_cache_timeout</code> is a cache timeout setting in seconds for metadata fetch of this database. Specify it as <strong>\\"metadata_cache_timeout\\": {\\"schema_cache_timeout\\": 600, \\"table_cache_timeout\\": 600}</strong>. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.<br>3. The <code>schemas_allowed_for_file_upload</code> is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as <strong>\\"schemas_allowed_for_file_upload\\": [\\"public\\", \\"csv_upload\\"]</strong>. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty<br>4. The <code>version</code> field is a string specifying the this db\'s version. This should be used with Presto DBs so that the syntax is correct<br>5. The <code>allows_virtual_table_explore</code> field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.<br>6. The <code>disable_data_preview</code> field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.</p>","type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.<br/>If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"masked_encrypted_extra":{"description":"<p>JSON string containing additional connection configuration.<br>This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.</p>","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"<p>Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.</p>","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"<p>Refer to the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_2/core/engines.html#database-urls\\" rel=\\"noopener noreferrer\\">SqlAlchemy docs</a> for more information on how to structure your URI.</p>","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"$ref":"#/components/schemas/DatabaseSSHTunnel"}],"nullable":true}},"type":"object"},"DatabaseValidateParametersSchema":{"properties":{"catalog":{"additionalProperties":{"nullable":true},"description":"Gsheets specific column for managing label to sheet urls","type":"object"},"configuration_method":{"description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","type":"string"},"extra":{"description":"<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\\" rel=\\"noopener noreferrer\\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\\" rel=\\"noopener noreferrer\\">sqlalchemy.MetaData</a> call.<br>2. The <code>metadata_cache_timeout</code> is a cache timeout setting in seconds for metadata fetch of this database. Specify it as <strong>\\"metadata_cache_timeout\\": {\\"schema_cache_timeout\\": 600, \\"table_cache_timeout\\": 600}</strong>. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.<br>3. The <code>schemas_allowed_for_file_upload</code> is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as <strong>\\"schemas_allowed_for_file_upload\\": [\\"public\\", \\"csv_upload\\"]</strong>. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty<br>4. The <code>version</code> field is a string specifying the this db\'s version. This should be used with Presto DBs so that the syntax is correct<br>5. The <code>allows_virtual_table_explore</code> field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.<br>6. The <code>disable_data_preview</code> field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.</p>","type":"string"},"id":{"description":"Database ID (for updates)","nullable":true,"type":"integer"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.<br/>If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"masked_encrypted_extra":{"description":"<p>JSON string containing additional connection configuration.<br>This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.</p>","nullable":true,"type":"string"},"parameters":{"additionalProperties":{"nullable":true},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"<p>Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.</p>","nullable":true,"type":"string"}},"required":["configuration_method","engine"],"type":"object"},"Dataset":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this dataset.","type":"integer"},"column_formats":{"description":"Column formats.","type":"object"},"columns":{"description":"Columns metadata.","items":{"type":"object"},"type":"array"},"currency_formats":{"description":"Currency formats.","type":"object"},"database":{"description":"Database associated with the dataset.","type":"object"},"datasource_name":{"description":"Dataset name.","type":"string"},"default_endpoint":{"description":"Default endpoint for the dataset.","type":"string"},"description":{"description":"Dataset description.","type":"string"},"edit_url":{"description":"The URL for editing the dataset.","type":"string"},"extra":{"description":"JSON string containing extra configuration elements.","type":"object"},"fetch_values_predicate":{"description":"Predicate used when fetching values from the dataset.","type":"string"},"filter_select":{"description":"SELECT filter applied to the dataset.","type":"boolean"},"filter_select_enabled":{"description":"If the SELECT filter is enabled.","type":"boolean"},"granularity_sqla":{"description":"Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use `granularity` instead.","items":{"items":{"type":"object"},"type":"array"},"type":"array"},"health_check_message":{"description":"Health check message.","type":"string"},"id":{"description":"Dataset ID.","type":"integer"},"is_sqllab_view":{"description":"If the dataset is a SQL Lab view.","type":"boolean"},"main_dttm_col":{"description":"The main temporal column.","type":"string"},"metrics":{"description":"Dataset metrics.","items":{"type":"object"},"type":"array"},"name":{"description":"Dataset name.","type":"string"},"offset":{"description":"Dataset offset.","type":"integer"},"order_by_choices":{"description":"List of order by columns.","items":{"items":{"type":"string"},"type":"array"},"type":"array"},"owners":{"description":"List of owners identifiers","items":{"type":"integer"},"type":"array"},"params":{"description":"Extra params for the dataset.","type":"object"},"perm":{"description":"Permission expression.","type":"string"},"schema":{"description":"Dataset schema.","type":"string"},"select_star":{"description":"Select all clause.","type":"string"},"sql":{"description":"A SQL statement that defines the dataset.","type":"string"},"table_name":{"description":"The name of the table associated with the dataset.","type":"string"},"template_params":{"description":"Table template params.","type":"object"},"time_grain_sqla":{"description":"List of temporal granularities supported by the dataset.","items":{"items":{"type":"string"},"type":"array"},"type":"array"},"type":{"description":"Dataset type.","type":"string"},"uid":{"description":"Dataset unique identifier.","type":"string"},"verbose_map":{"description":"Mapping from raw name to verbose name.","type":"object"}},"type":"object"},"DatasetCacheWarmUpRequestSchema":{"properties":{"dashboard_id":{"description":"The ID of the dashboard to get filters for when warming cache","type":"integer"},"db_name":{"description":"The name of the database where the table is located","type":"string"},"extra_filters":{"description":"Extra filters to apply when warming up cache","type":"string"},"table_name":{"description":"The name of the table to warm up cache for","type":"string"}},"required":["db_name","table_name"],"type":"object"},"DatasetCacheWarmUpResponseSchema":{"properties":{"result":{"description":"A list of each chart\'s warmup status and errors if any","items":{"$ref":"#/components/schemas/DatasetCacheWarmUpResponseSingle"},"type":"array"}},"type":"object"},"DatasetCacheWarmUpResponseSingle":{"properties":{"chart_id":{"description":"The ID of the chart the status belongs to","type":"integer"},"viz_error":{"description":"Error that occurred when warming cache for chart","type":"string"},"viz_status":{"description":"Status of the underlying query for the viz","type":"string"}},"type":"object"},"DatasetColumnsPut":{"properties":{"advanced_data_type":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"column_name":{"maxLength":255,"minLength":1,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"filterable":{"type":"boolean"},"groupby":{"type":"boolean"},"id":{"type":"integer"},"is_active":{"nullable":true,"type":"boolean"},"is_dttm":{"nullable":true,"type":"boolean"},"python_date_format":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"nullable":true,"type":"string"}},"required":["column_name"],"type":"object"},"DatasetColumnsRestApi.get":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetColumnsRestApi.get_list":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetColumnsRestApi.post":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetColumnsRestApi.put":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetDuplicateSchema":{"properties":{"base_model_id":{"type":"integer"},"table_name":{"maxLength":250,"minLength":1,"type":"string"}},"required":["base_model_id","table_name"],"type":"object"},"DatasetMetricRestApi.get":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetMetricRestApi.get_list":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetMetricRestApi.post":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetMetricRestApi.put":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetMetricsPut":{"properties":{"currency":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"d3format":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"type":"string"},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"metric_name":{"maxLength":255,"minLength":1,"type":"string"},"metric_type":{"maxLength":32,"minLength":1,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"nullable":true,"type":"string"},"warning_text":{"nullable":true,"type":"string"}},"required":["expression","metric_name"],"type":"object"},"DatasetRelatedChart":{"properties":{"id":{"type":"integer"},"slice_name":{"type":"string"},"viz_type":{"type":"string"}},"type":"object"},"DatasetRelatedCharts":{"properties":{"count":{"description":"Chart count","type":"integer"},"result":{"description":"A list of dashboards","items":{"$ref":"#/components/schemas/DatasetRelatedChart"},"type":"array"}},"type":"object"},"DatasetRelatedDashboard":{"properties":{"id":{"type":"integer"},"json_metadata":{"type":"object"},"slug":{"type":"string"},"title":{"type":"string"}},"type":"object"},"DatasetRelatedDashboards":{"properties":{"count":{"description":"Dashboard count","type":"integer"},"result":{"description":"A list of dashboards","items":{"$ref":"#/components/schemas/DatasetRelatedDashboard"},"type":"array"}},"type":"object"},"DatasetRelatedObjectsResponse":{"properties":{"charts":{"$ref":"#/components/schemas/DatasetRelatedCharts"},"dashboards":{"$ref":"#/components/schemas/DatasetRelatedDashboards"}},"type":"object"},"DatasetRestApi.get":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"changed_by":{"$ref":"#/components/schemas/DatasetRestApi.get.User2"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_humanized":{"readOnly":true},"column_formats":{"readOnly":true},"columns":{"$ref":"#/components/schemas/DatasetRestApi.get.TableColumn"},"created_by":{"$ref":"#/components/schemas/DatasetRestApi.get.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"created_on_humanized":{"readOnly":true},"currency_formats":{"readOnly":true},"database":{"$ref":"#/components/schemas/DatasetRestApi.get.Database"},"datasource_name":{"readOnly":true},"datasource_type":{"readOnly":true},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"fetch_values_predicate":{"nullable":true,"type":"string"},"filter_select_enabled":{"nullable":true,"type":"boolean"},"granularity_sqla":{"readOnly":true},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"is_sqllab_view":{"nullable":true,"type":"boolean"},"kind":{"readOnly":true},"main_dttm_col":{"maxLength":250,"nullable":true,"type":"string"},"metrics":{"$ref":"#/components/schemas/DatasetRestApi.get.SqlMetric"},"name":{"readOnly":true},"offset":{"nullable":true,"type":"integer"},"order_by_choices":{"readOnly":true},"owners":{"$ref":"#/components/schemas/DatasetRestApi.get.User1"},"schema":{"maxLength":255,"nullable":true,"type":"string"},"select_star":{"readOnly":true},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"},"template_params":{"nullable":true,"type":"string"},"time_grain_sqla":{"readOnly":true},"uid":{"readOnly":true},"url":{"readOnly":true},"verbose_map":{"readOnly":true}},"required":["columns","database","metrics","table_name"],"type":"object"},"DatasetRestApi.get.Database":{"properties":{"backend":{"readOnly":true},"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object"},"DatasetRestApi.get.SqlMetric":{"properties":{"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"currency":{"maxLength":128,"nullable":true,"type":"string"},"d3format":{"maxLength":128,"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"type":"string"},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"metric_name":{"maxLength":255,"type":"string"},"metric_type":{"maxLength":32,"nullable":true,"type":"string"},"verbose_name":{"maxLength":1024,"nullable":true,"type":"string"},"warning_text":{"nullable":true,"type":"string"}},"required":["expression","metric_name"],"type":"object"},"DatasetRestApi.get.TableColumn":{"properties":{"advanced_data_type":{"maxLength":255,"nullable":true,"type":"string"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"column_name":{"maxLength":255,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"filterable":{"nullable":true,"type":"boolean"},"groupby":{"nullable":true,"type":"boolean"},"id":{"type":"integer"},"is_active":{"nullable":true,"type":"boolean"},"is_dttm":{"nullable":true,"type":"boolean"},"python_date_format":{"maxLength":255,"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"},"type_generic":{"readOnly":true},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"maxLength":1024,"nullable":true,"type":"string"}},"required":["column_name"],"type":"object"},"DatasetRestApi.get.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DatasetRestApi.get.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DatasetRestApi.get.User2":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DatasetRestApi.get_list":{"properties":{"changed_by":{"$ref":"#/components/schemas/DatasetRestApi.get_list.User1"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_utc":{"readOnly":true},"database":{"$ref":"#/components/schemas/DatasetRestApi.get_list.Database"},"datasource_type":{"readOnly":true},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"explore_url":{"readOnly":true},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"kind":{"readOnly":true},"owners":{"$ref":"#/components/schemas/DatasetRestApi.get_list.User"},"schema":{"maxLength":255,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"}},"required":["database","table_name"],"type":"object"},"DatasetRestApi.get_list.Database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object"},"DatasetRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DatasetRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DatasetRestApi.post":{"properties":{"database":{"type":"integer"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"type":"integer"},"type":"array"},"schema":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"minLength":1,"type":"string"}},"required":["database","table_name"],"type":"object"},"DatasetRestApi.put":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"columns":{"items":{"$ref":"#/components/schemas/DatasetColumnsPut"},"type":"array"},"database_id":{"type":"integer"},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"fetch_values_predicate":{"maxLength":1000,"minLength":0,"nullable":true,"type":"string"},"filter_select_enabled":{"nullable":true,"type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"is_sqllab_view":{"nullable":true,"type":"boolean"},"main_dttm_col":{"nullable":true,"type":"string"},"metrics":{"items":{"$ref":"#/components/schemas/DatasetMetricsPut"},"type":"array"},"offset":{"nullable":true,"type":"integer"},"owners":{"items":{"type":"integer"},"type":"array"},"schema":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"minLength":1,"nullable":true,"type":"string"},"template_params":{"nullable":true,"type":"string"}},"type":"object"},"Datasource":{"properties":{"database_name":{"description":"Datasource name","type":"string"},"datasource_name":{"description":"The datasource name.","type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["sl_table","table","dataset","query","saved_query","view"],"type":"string"},"schema":{"description":"Datasource schema","type":"string"}},"required":["datasource_type"],"type":"object"},"DistincResponseSchema":{"properties":{"count":{"description":"The total number of distinct values","type":"integer"},"result":{"items":{"$ref":"#/components/schemas/DistinctResultResponse"},"type":"array"}},"type":"object"},"DistinctResultResponse":{"properties":{"text":{"description":"The distinct item","type":"string"}},"type":"object"},"EmbeddedDashboardConfig":{"properties":{"allowed_domains":{"items":{"type":"string"},"type":"array"}},"required":["allowed_domains"],"type":"object"},"EmbeddedDashboardResponseSchema":{"properties":{"allowed_domains":{"items":{"type":"string"},"type":"array"},"changed_by":{"$ref":"#/components/schemas/User1"},"changed_on":{"format":"date-time","type":"string"},"dashboard_id":{"type":"string"},"uuid":{"type":"string"}},"type":"object"},"EmbeddedDashboardRestApi.get":{"properties":{"uuid":{"format":"uuid","type":"string"}},"type":"object"},"EmbeddedDashboardRestApi.get_list":{"properties":{"uuid":{"format":"uuid","type":"string"}},"type":"object"},"EmbeddedDashboardRestApi.post":{"properties":{"uuid":{"format":"uuid","type":"string"}},"type":"object"},"EmbeddedDashboardRestApi.put":{"properties":{"uuid":{"format":"uuid","type":"string"}},"type":"object"},"EstimateQueryCostSchema":{"properties":{"database_id":{"description":"The database id","type":"integer"},"schema":{"description":"The database schema","nullable":true,"type":"string"},"sql":{"description":"The SQL query to estimate","type":"string"},"template_params":{"description":"The SQL query template params","type":"object"}},"required":["database_id","sql"],"type":"object"},"ExecutePayloadSchema":{"properties":{"client_id":{"nullable":true,"type":"string"},"ctas_method":{"nullable":true,"type":"string"},"database_id":{"type":"integer"},"expand_data":{"nullable":true,"type":"boolean"},"json":{"nullable":true,"type":"boolean"},"queryLimit":{"nullable":true,"type":"integer"},"runAsync":{"nullable":true,"type":"boolean"},"schema":{"nullable":true,"type":"string"},"select_as_cta":{"nullable":true,"type":"boolean"},"sql":{"type":"string"},"sql_editor_id":{"nullable":true,"type":"string"},"tab":{"nullable":true,"type":"string"},"templateParams":{"nullable":true,"type":"string"},"tmp_table_name":{"nullable":true,"type":"string"}},"required":["database_id","sql"],"type":"object"},"ExploreContextSchema":{"properties":{"dataset":{"$ref":"#/components/schemas/Dataset"},"form_data":{"description":"Form data from the Explore controls used to form the chart\'s data query.","type":"object"},"message":{"description":"Any message related to the processed request.","type":"string"},"slice":{"$ref":"#/components/schemas/Slice"}},"type":"object"},"ExplorePermalinkStateSchema":{"properties":{"formData":{"description":"Chart form data","type":"object"},"urlParams":{"description":"URL Parameters","items":{"description":"URL Parameter key-value pair","nullable":true},"nullable":true,"type":"array"}},"required":["formData"],"type":"object"},"FilterSetRestApi.get":{"properties":{"dashboard_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":500,"type":"string"},"owner_id":{"type":"integer"},"owner_type":{"maxLength":255,"type":"string"},"params":{"readOnly":true}},"required":["name","owner_id","owner_type"],"type":"object"},"FilterSetRestApi.get_list":{"properties":{"changed_by_fk":{"nullable":true,"type":"integer"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_by_fk":{"nullable":true,"type":"integer"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"dashboard_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":500,"type":"string"},"owner_id":{"type":"integer"},"owner_type":{"maxLength":255,"type":"string"},"params":{"readOnly":true}},"required":["name","owner_id","owner_type"],"type":"object"},"FilterSetRestApi.post":{"properties":{"description":{"maxLength":1000,"minLength":1,"nullable":true,"type":"string"},"json_metadata":{"type":"string"},"name":{"maxLength":500,"minLength":0,"type":"string"},"owner_id":{"type":"integer"},"owner_type":{"enum":["User","Dashboard"],"type":"string"}},"required":["json_metadata","name","owner_type"],"type":"object"},"FilterSetRestApi.put":{"properties":{"description":{"maxLength":1000,"minLength":1,"type":"string"},"json_metadata":{"type":"string"},"name":{"maxLength":500,"minLength":0,"type":"string"},"owner_type":{"enum":["Dashboard"],"type":"string"}},"type":"object"},"FormDataPostSchema":{"properties":{"chart_id":{"description":"The chart ID","type":"integer"},"datasource_id":{"description":"The datasource ID","type":"integer"},"datasource_type":{"description":"The datasource type","enum":["sl_table","table","dataset","query","saved_query","view"],"type":"string"},"form_data":{"description":"Any type of JSON supported text.","type":"string"}},"required":["datasource_id","datasource_type","form_data"],"type":"object"},"FormDataPutSchema":{"properties":{"chart_id":{"description":"The chart ID","type":"integer"},"datasource_id":{"description":"The datasource ID","type":"integer"},"datasource_type":{"description":"The datasource type","enum":["sl_table","table","dataset","query","saved_query","view"],"type":"string"},"form_data":{"description":"Any type of JSON supported text.","type":"string"}},"required":["datasource_id","datasource_type","form_data"],"type":"object"},"GetFavStarIdsSchema":{"properties":{"result":{"description":"A list of results for each corresponding chart in the request","items":{"$ref":"#/components/schemas/ChartFavStarResponseResult"},"type":"array"}},"type":"object"},"GetOrCreateDatasetSchema":{"properties":{"database_id":{"description":"ID of database table belongs to","type":"integer"},"schema":{"description":"The schema the table belongs to","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"table_name":{"description":"Name of table","type":"string"},"template_params":{"description":"Template params for the table","type":"string"}},"required":["database_id","table_name"],"type":"object"},"GuestTokenCreate":{"properties":{"resources":{"items":{"$ref":"#/components/schemas/Resource"},"type":"array"},"rls":{"items":{"$ref":"#/components/schemas/RlsRule"},"type":"array"},"user":{"$ref":"#/components/schemas/User2"}},"required":["resources","rls"],"type":"object"},"LogRestApi.get":{"properties":{"action":{"maxLength":512,"nullable":true,"type":"string"},"dashboard_id":{"nullable":true,"type":"integer"},"dttm":{"format":"date-time","nullable":true,"type":"string"},"duration_ms":{"nullable":true,"type":"integer"},"json":{"nullable":true,"type":"string"},"referrer":{"maxLength":1024,"nullable":true,"type":"string"},"slice_id":{"nullable":true,"type":"integer"},"user":{"$ref":"#/components/schemas/LogRestApi.get.User"},"user_id":{"nullable":true,"type":"integer"}},"type":"object"},"LogRestApi.get.User":{"properties":{"username":{"maxLength":64,"type":"string"}},"required":["username"],"type":"object"},"LogRestApi.get_list":{"properties":{"action":{"maxLength":512,"nullable":true,"type":"string"},"dashboard_id":{"nullable":true,"type":"integer"},"dttm":{"format":"date-time","nullable":true,"type":"string"},"duration_ms":{"nullable":true,"type":"integer"},"json":{"nullable":true,"type":"string"},"referrer":{"maxLength":1024,"nullable":true,"type":"string"},"slice_id":{"nullable":true,"type":"integer"},"user":{"$ref":"#/components/schemas/LogRestApi.get_list.User"},"user_id":{"nullable":true,"type":"integer"}},"type":"object"},"LogRestApi.get_list.User":{"properties":{"username":{"maxLength":64,"type":"string"}},"required":["username"],"type":"object"},"LogRestApi.post":{"properties":{"id":{"type":"integer"}},"type":"object"},"LogRestApi.put":{"properties":{"action":{"maxLength":512,"nullable":true,"type":"string"},"dttm":{"format":"date-time","nullable":true,"type":"string"},"json":{"nullable":true,"type":"string"},"user":{"nullable":true}},"type":"object"},"QueryExecutionResponseSchema":{"properties":{"columns":{"items":{"type":"object"},"type":"array"},"data":{"items":{"type":"object"},"type":"array"},"expanded_columns":{"items":{"type":"object"},"type":"array"},"query":{"$ref":"#/components/schemas/QueryResult"},"query_id":{"type":"integer"},"selected_columns":{"items":{"type":"object"},"type":"array"},"status":{"type":"string"}},"type":"object"},"QueryRestApi.get":{"properties":{"changed_on":{"format":"date-time","nullable":true,"type":"string"},"client_id":{"maxLength":11,"type":"string"},"database":{"$ref":"#/components/schemas/QueryRestApi.get.Database"},"end_result_backend_time":{"nullable":true,"type":"number"},"end_time":{"nullable":true,"type":"number"},"error_message":{"nullable":true,"type":"string"},"executed_sql":{"nullable":true,"type":"string"},"id":{"type":"integer"},"limit":{"nullable":true,"type":"integer"},"progress":{"nullable":true,"type":"integer"},"results_key":{"maxLength":64,"nullable":true,"type":"string"},"rows":{"nullable":true,"type":"integer"},"schema":{"maxLength":256,"nullable":true,"type":"string"},"select_as_cta":{"nullable":true,"type":"boolean"},"select_as_cta_used":{"nullable":true,"type":"boolean"},"select_sql":{"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_editor_id":{"maxLength":256,"nullable":true,"type":"string"},"start_running_time":{"nullable":true,"type":"number"},"start_time":{"nullable":true,"type":"number"},"status":{"maxLength":16,"nullable":true,"type":"string"},"tab_name":{"maxLength":256,"nullable":true,"type":"string"},"tmp_schema_name":{"maxLength":256,"nullable":true,"type":"string"},"tmp_table_name":{"maxLength":256,"nullable":true,"type":"string"},"tracking_url":{"readOnly":true}},"required":["client_id","database"],"type":"object"},"QueryRestApi.get.Database":{"properties":{"id":{"type":"integer"}},"type":"object"},"QueryRestApi.get_list":{"properties":{"changed_on":{"format":"date-time","type":"string"},"database":{"$ref":"#/components/schemas/Database1"},"end_time":{"type":"number"},"executed_sql":{"type":"string"},"id":{"type":"integer"},"rows":{"type":"integer"},"schema":{"type":"string"},"sql":{"type":"string"},"sql_tables":{"readOnly":true},"start_time":{"type":"number"},"status":{"type":"string"},"tab_name":{"type":"string"},"tmp_table_name":{"type":"string"},"tracking_url":{"type":"string"},"user":{"$ref":"#/components/schemas/User"}},"type":"object"},"QueryRestApi.post":{"properties":{"id":{"type":"integer"}},"type":"object"},"QueryRestApi.put":{"properties":{"id":{"type":"integer"}},"type":"object"},"QueryResult":{"properties":{"changed_on":{"format":"date-time","type":"string"},"ctas":{"type":"boolean"},"db":{"type":"string"},"dbId":{"type":"integer"},"endDttm":{"type":"number"},"errorMessage":{"nullable":true,"type":"string"},"executedSql":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"limit":{"type":"integer"},"limitingFactor":{"type":"string"},"progress":{"type":"integer"},"queryId":{"type":"integer"},"resultsKey":{"type":"string"},"rows":{"type":"integer"},"schema":{"type":"string"},"serverId":{"type":"integer"},"sql":{"type":"string"},"sqlEditorId":{"type":"string"},"startDttm":{"type":"number"},"state":{"type":"string"},"tab":{"type":"string"},"tempSchema":{"nullable":true,"type":"string"},"tempTable":{"nullable":true,"type":"string"},"trackingUrl":{"nullable":true,"type":"string"},"user":{"type":"string"},"userId":{"type":"integer"}},"type":"object"},"RLSRestApi.get":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","type":"string"},"id":{"description":"id_description","type":"integer"},"name":{"description":"name_description","type":"string"},"roles":{"items":{"$ref":"#/components/schemas/Roles1"},"type":"array"},"tables":{"items":{"$ref":"#/components/schemas/Tables"},"type":"array"}},"type":"object"},"RLSRestApi.get_list":{"properties":{"changed_on_delta_humanized":{"readOnly":true},"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","type":"string"},"id":{"description":"id_description","type":"integer"},"name":{"description":"name_description","type":"string"},"roles":{"items":{"$ref":"#/components/schemas/Roles1"},"type":"array"},"tables":{"items":{"$ref":"#/components/schemas/Tables"},"type":"array"}},"type":"object"},"RLSRestApi.post":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","nullable":true,"type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","nullable":true,"type":"string"},"name":{"description":"name_description","maxLength":255,"minLength":1,"type":"string"},"roles":{"description":"roles_description","items":{"type":"integer"},"type":"array"},"tables":{"description":"tables_description","items":{"type":"integer"},"minItems":1,"type":"array"}},"required":["clause","filter_type","name","roles","tables"],"type":"object"},"RLSRestApi.put":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","nullable":true,"type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","nullable":true,"type":"string"},"name":{"description":"name_description","maxLength":255,"minLength":1,"type":"string"},"roles":{"description":"roles_description","items":{"type":"integer"},"type":"array"},"tables":{"description":"tables_description","items":{"type":"integer"},"type":"array"}},"type":"object"},"RecentActivity":{"properties":{"action":{"description":"Action taken describing type of activity","type":"string"},"item_title":{"description":"Title of item","type":"string"},"item_type":{"description":"Type of item, e.g. slice or dashboard","type":"string"},"item_url":{"description":"URL to item","type":"string"},"time":{"description":"Time of activity, in epoch milliseconds","type":"number"},"time_delta_humanized":{"description":"Human-readable description of how long ago activity took place.","type":"string"}},"type":"object"},"RecentActivityResponseSchema":{"properties":{"result":{"description":"A list of recent activity objects","items":{"$ref":"#/components/schemas/RecentActivity"},"type":"array"}},"type":"object"},"RecentActivitySchema":{"properties":{"action":{"description":"Action taken describing type of activity","type":"string"},"item_title":{"description":"Title of item","type":"string"},"item_type":{"description":"Type of item, e.g. slice or dashboard","type":"string"},"item_url":{"description":"URL to item","type":"string"},"time":{"description":"Time of activity, in epoch milliseconds","type":"number"},"time_delta_humanized":{"description":"Human-readable description of how long ago activity took place.","type":"string"}},"type":"object"},"RelatedResponseSchema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"$ref":"#/components/schemas/RelatedResultResponse"},"type":"array"}},"type":"object"},"RelatedResultResponse":{"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"},"ReportExecutionLogRestApi.get":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"id":{"type":"integer"},"scheduled_dttm":{"format":"date-time","type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"},"state":{"maxLength":50,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"value":{"nullable":true,"type":"number"},"value_row_json":{"nullable":true,"type":"string"}},"required":["scheduled_dttm","state"],"type":"object"},"ReportExecutionLogRestApi.get_list":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"id":{"type":"integer"},"scheduled_dttm":{"format":"date-time","type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"},"state":{"maxLength":50,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"value":{"nullable":true,"type":"number"},"value_row_json":{"nullable":true,"type":"string"}},"required":["scheduled_dttm","state"],"type":"object"},"ReportExecutionLogRestApi.post":{"properties":{"id":{"type":"integer"}},"type":"object"},"ReportExecutionLogRestApi.put":{"properties":{"id":{"type":"integer"}},"type":"object"},"ReportRecipient":{"properties":{"recipient_config_json":{"$ref":"#/components/schemas/ReportRecipientConfigJSON"},"type":{"description":"The recipient type, check spec for valid options","enum":["Email","Slack"],"type":"string"}},"required":["type"],"type":"object"},"ReportRecipientConfigJSON":{"properties":{"target":{"type":"string"}},"type":"object"},"ReportScheduleRestApi.get":{"properties":{"active":{"nullable":true,"type":"boolean"},"chart":{"$ref":"#/components/schemas/ReportScheduleRestApi.get.Slice"},"context_markdown":{"nullable":true,"type":"string"},"creation_method":{"maxLength":255,"nullable":true,"type":"string"},"crontab":{"maxLength":1000,"type":"string"},"custom_width":{"nullable":true,"type":"integer"},"dashboard":{"$ref":"#/components/schemas/ReportScheduleRestApi.get.Dashboard"},"database":{"$ref":"#/components/schemas/ReportScheduleRestApi.get.Database"},"description":{"nullable":true,"type":"string"},"extra":{"readOnly":true},"force_screenshot":{"nullable":true,"type":"boolean"},"grace_period":{"nullable":true,"type":"integer"},"id":{"type":"integer"},"last_eval_dttm":{"format":"date-time","nullable":true,"type":"string"},"last_state":{"maxLength":50,"nullable":true,"type":"string"},"last_value":{"nullable":true,"type":"number"},"last_value_row_json":{"nullable":true,"type":"string"},"log_retention":{"nullable":true,"type":"integer"},"name":{"maxLength":150,"type":"string"},"owners":{"$ref":"#/components/schemas/ReportScheduleRestApi.get.User"},"recipients":{"$ref":"#/components/schemas/ReportScheduleRestApi.get.ReportRecipients"},"report_format":{"maxLength":50,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"timezone":{"maxLength":100,"type":"string"},"type":{"maxLength":50,"type":"string"},"validator_config_json":{"nullable":true,"type":"string"},"validator_type":{"maxLength":100,"nullable":true,"type":"string"},"working_timeout":{"nullable":true,"type":"integer"}},"required":["crontab","name","recipients","type"],"type":"object"},"ReportScheduleRestApi.get.Dashboard":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object"},"ReportScheduleRestApi.get.Database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object"},"ReportScheduleRestApi.get.ReportRecipients":{"properties":{"id":{"type":"integer"},"recipient_config_json":{"nullable":true,"type":"string"},"type":{"maxLength":50,"type":"string"}},"required":["type"],"type":"object"},"ReportScheduleRestApi.get.Slice":{"properties":{"id":{"type":"integer"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"ReportScheduleRestApi.get.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ReportScheduleRestApi.get_list":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_by":{"$ref":"#/components/schemas/ReportScheduleRestApi.get_list.User2"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"chart_id":{"nullable":true,"type":"integer"},"created_by":{"$ref":"#/components/schemas/ReportScheduleRestApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"creation_method":{"maxLength":255,"nullable":true,"type":"string"},"crontab":{"maxLength":1000,"type":"string"},"crontab_humanized":{"readOnly":true},"dashboard_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra":{"readOnly":true},"id":{"type":"integer"},"last_eval_dttm":{"format":"date-time","nullable":true,"type":"string"},"last_state":{"maxLength":50,"nullable":true,"type":"string"},"name":{"maxLength":150,"type":"string"},"owners":{"$ref":"#/components/schemas/ReportScheduleRestApi.get_list.User1"},"recipients":{"$ref":"#/components/schemas/ReportScheduleRestApi.get_list.ReportRecipients"},"timezone":{"maxLength":100,"type":"string"},"type":{"maxLength":50,"type":"string"}},"required":["crontab","name","recipients","type"],"type":"object"},"ReportScheduleRestApi.get_list.ReportRecipients":{"properties":{"id":{"type":"integer"},"type":{"maxLength":50,"type":"string"}},"required":["type"],"type":"object"},"ReportScheduleRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ReportScheduleRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ReportScheduleRestApi.get_list.User2":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ReportScheduleRestApi.post":{"properties":{"active":{"type":"boolean"},"chart":{"nullable":true,"type":"integer"},"context_markdown":{"description":"Markdown description","nullable":true,"type":"string"},"creation_method":{"description":"Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.","enum":["charts","dashboards","alerts_reports"]},"crontab":{"description":"A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.","example":"*/5 * * * *","maxLength":1000,"minLength":1,"type":"string"},"custom_width":{"description":"Custom width of the screenshot in pixels","example":1000,"nullable":true,"type":"integer"},"dashboard":{"nullable":true,"type":"integer"},"database":{"type":"integer"},"description":{"description":"Use a nice description to give context to this Alert/Report","example":"Daily sales dashboard to marketing","nullable":true,"type":"string"},"extra":{"type":"object"},"force_screenshot":{"type":"boolean"},"grace_period":{"description":"Once an alert is triggered, how long, in seconds, before Superset nags you again. (in seconds)","example":14400,"minimum":1,"type":"integer"},"log_retention":{"description":"How long to keep the logs around for this report (in days)","example":90,"minimum":1,"type":"integer"},"name":{"description":"The report schedule name.","example":"Daily dashboard email","maxLength":150,"minLength":1,"type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this report. If left empty you will be one of the owners of the report.","type":"integer"},"type":"array"},"recipients":{"items":{"$ref":"#/components/schemas/ReportRecipient"},"type":"array"},"report_format":{"enum":["PNG","CSV","TEXT"],"type":"string"},"selected_tabs":{"items":{"type":"integer"},"nullable":true,"type":"array"},"sql":{"description":"A SQL statement that defines whether the alert should get triggered or not. The query is expected to return either NULL or a number value.","example":"SELECT value FROM time_series_table","type":"string"},"timezone":{"description":"A timezone string that represents the location of the timezone.","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"type":"string"},"type":{"description":"The report schedule type","enum":["Alert","Report"],"type":"string"},"validator_config_json":{"$ref":"#/components/schemas/ValidatorConfigJSON"},"validator_type":{"description":"Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\\n- Not Null - When the return value is Not NULL, Empty, or 0\\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`<br>Supports the comparison operators <, <=, >, >=, ==, and !=","enum":["not null","operator"],"type":"string"},"working_timeout":{"description":"If an alert is staled at a working state, how long until it\'s state is reseted to error","example":3600,"minimum":1,"type":"integer"}},"required":["crontab","name","type"],"type":"object"},"ReportScheduleRestApi.put":{"properties":{"active":{"type":"boolean"},"chart":{"nullable":true,"type":"integer"},"context_markdown":{"description":"Markdown description","nullable":true,"type":"string"},"creation_method":{"description":"Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.","enum":["charts","dashboards","alerts_reports"],"nullable":true},"crontab":{"description":"A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.","maxLength":1000,"minLength":1,"type":"string"},"custom_width":{"description":"Custom width of the screenshot in pixels","example":1000,"nullable":true,"type":"integer"},"dashboard":{"nullable":true,"type":"integer"},"database":{"type":"integer"},"description":{"description":"Use a nice description to give context to this Alert/Report","example":"Daily sales dashboard to marketing","nullable":true,"type":"string"},"extra":{"type":"object"},"force_screenshot":{"type":"boolean"},"grace_period":{"description":"Once an alert is triggered, how long, in seconds, before Superset nags you again. (in seconds)","example":14400,"minimum":1,"type":"integer"},"log_retention":{"description":"How long to keep the logs around for this report (in days)","example":90,"minimum":1,"type":"integer"},"name":{"description":"The report schedule name.","maxLength":150,"minLength":1,"type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this report. If left empty you will be one of the owners of the report.","type":"integer"},"type":"array"},"recipients":{"items":{"$ref":"#/components/schemas/ReportRecipient"},"type":"array"},"report_format":{"enum":["PNG","CSV","TEXT"],"type":"string"},"sql":{"description":"A SQL statement that defines whether the alert should get triggered or not. The query is expected to return either NULL or a number value.","example":"SELECT value FROM time_series_table","nullable":true,"type":"string"},"timezone":{"description":"A timezone string that represents the location of the timezone.","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"type":"string"},"type":{"description":"The report schedule type","enum":["Alert","Report"],"type":"string"},"validator_config_json":{"$ref":"#/components/schemas/ValidatorConfigJSON"},"validator_type":{"description":"Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\\n- Not Null - When the return value is Not NULL, Empty, or 0\\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`<br>Supports the comparison operators <, <=, >, >=, ==, and !=","enum":["not null","operator"],"nullable":true,"type":"string"},"working_timeout":{"description":"If an alert is staled at a working state, how long until it\'s state is reseted to error","example":3600,"minimum":1,"nullable":true,"type":"integer"}},"type":"object"},"Resource":{"properties":{"id":{"type":"string"},"type":{"enum":["dashboard"]}},"required":["id","type"],"type":"object"},"RlsRule":{"properties":{"clause":{"type":"string"},"dataset":{"type":"integer"}},"required":["clause"],"type":"object"},"Roles":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"Roles1":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"SavedQueryRestApi.get":{"properties":{"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/SavedQueryRestApi.get.User"},"database":{"$ref":"#/components/schemas/SavedQueryRestApi.get.Database"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_tables":{"readOnly":true},"template_parameters":{"nullable":true,"type":"string"}},"type":"object"},"SavedQueryRestApi.get.Database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object"},"SavedQueryRestApi.get.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"SavedQueryRestApi.get_list":{"properties":{"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/SavedQueryRestApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"database":{"$ref":"#/components/schemas/SavedQueryRestApi.get_list.Database"},"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra":{"readOnly":true},"id":{"type":"integer"},"label":{"maxLength":256,"nullable":true,"type":"string"},"last_run_delta_humanized":{"readOnly":true},"rows":{"nullable":true,"type":"integer"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_tables":{"readOnly":true},"tags":{"$ref":"#/components/schemas/SavedQueryRestApi.get_list.Tag"}},"type":"object"},"SavedQueryRestApi.get_list.Database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object"},"SavedQueryRestApi.get_list.Tag":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"SavedQueryRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"SavedQueryRestApi.post":{"properties":{"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"template_parameters":{"nullable":true,"type":"string"}},"type":"object"},"SavedQueryRestApi.put":{"properties":{"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"template_parameters":{"nullable":true,"type":"string"}},"type":"object"},"SchemasResponseSchema":{"properties":{"result":{"items":{"description":"A database schema name","type":"string"},"type":"array"}},"type":"object"},"SelectStarResponseSchema":{"properties":{"result":{"description":"SQL select star","type":"string"}},"type":"object"},"Slice":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart.","type":"integer"},"certification_details":{"description":"Details of the certification.","type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard.","type":"string"},"changed_on":{"description":"Timestamp of the last modification.","format":"date-time","type":"string"},"changed_on_humanized":{"description":"Timestamp of the last modification in human readable form.","type":"string"},"datasource":{"description":"Datasource identifier.","type":"string"},"description":{"description":"Slice description.","type":"string"},"description_markeddown":{"description":"Sanitized HTML version of the chart description.","type":"string"},"edit_url":{"description":"The URL for editing the slice.","type":"string"},"form_data":{"description":"Form data associated with the slice.","type":"object"},"is_managed_externally":{"description":"If the chart is managed outside externally.","type":"boolean"},"modified":{"description":"Last modification in human readable form.","type":"string"},"owners":{"description":"Owners identifiers.","items":{"type":"integer"},"type":"array"},"query_context":{"description":"The context associated with the query.","type":"object"},"slice_id":{"description":"The slice ID.","type":"integer"},"slice_name":{"description":"The slice name.","type":"string"},"slice_url":{"description":"The slice URL.","type":"string"}},"type":"object"},"StopQuerySchema":{"properties":{"client_id":{"type":"string"}},"type":"object"},"TableExtraMetadataResponseSchema":{"properties":{"clustering":{"type":"object"},"metadata":{"type":"object"},"partitions":{"type":"object"}},"type":"object"},"TableMetadataColumnsResponse":{"properties":{"duplicates_constraint":{"type":"string"},"keys":{"description":"","items":{"type":"string"},"type":"array"},"longType":{"description":"The actual backend long type for the column","type":"string"},"name":{"description":"The column name","type":"string"},"type":{"description":"The column type","type":"string"}},"type":"object"},"TableMetadataForeignKeysIndexesResponse":{"properties":{"column_names":{"items":{"description":"A list of column names that compose the foreign key or index","type":"string"},"type":"array"},"name":{"description":"The name of the foreign key or index","type":"string"},"options":{"$ref":"#/components/schemas/TableMetadataOptionsResponse"},"referred_columns":{"items":{"type":"string"},"type":"array"},"referred_schema":{"type":"string"},"referred_table":{"type":"string"},"type":{"type":"string"}},"type":"object"},"TableMetadataOptionsResponse":{"properties":{"deferrable":{"type":"boolean"},"initially":{"type":"boolean"},"match":{"type":"boolean"},"ondelete":{"type":"boolean"},"onupdate":{"type":"boolean"}},"type":"object"},"TableMetadataPrimaryKeyResponse":{"properties":{"column_names":{"items":{"description":"A list of column names that compose the primary key","type":"string"},"type":"array"},"name":{"description":"The primary key index name","type":"string"},"type":{"type":"string"}},"type":"object"},"TableMetadataResponseSchema":{"properties":{"columns":{"description":"A list of columns and their metadata","items":{"$ref":"#/components/schemas/TableMetadataColumnsResponse"},"type":"array"},"foreignKeys":{"description":"A list of foreign keys and their metadata","items":{"$ref":"#/components/schemas/TableMetadataForeignKeysIndexesResponse"},"type":"array"},"indexes":{"description":"A list of indexes and their metadata","items":{"$ref":"#/components/schemas/TableMetadataForeignKeysIndexesResponse"},"type":"array"},"name":{"description":"The name of the table","type":"string"},"primaryKey":{"allOf":[{"$ref":"#/components/schemas/TableMetadataPrimaryKeyResponse"}],"description":"Primary keys metadata"},"selectStar":{"description":"SQL select star","type":"string"}},"type":"object"},"Tables":{"properties":{"id":{"type":"integer"},"schema":{"type":"string"},"table_name":{"type":"string"}},"type":"object"},"Tag":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"Tag1":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"TagGetResponseSchema":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"TagRestApi.get":{"properties":{"changed_by":{"$ref":"#/components/schemas/TagRestApi.get.User1"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/TagRestApi.get.User"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"TagRestApi.get.User":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"email":{"maxLength":64,"type":"string"},"fail_login_count":{"nullable":true,"type":"integer"},"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_login":{"format":"date-time","nullable":true,"type":"string"},"last_name":{"maxLength":64,"type":"string"},"login_count":{"nullable":true,"type":"integer"},"password":{"maxLength":256,"nullable":true,"type":"string"},"username":{"maxLength":64,"type":"string"}},"required":["email","first_name","last_name","username"],"type":"object"},"TagRestApi.get.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"TagRestApi.get_list":{"properties":{"changed_by":{"$ref":"#/components/schemas/TagRestApi.get_list.User1"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/TagRestApi.get_list.User"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"TagRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"TagRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"TagRestApi.post":{"properties":{"tags":{"items":{"type":"string"},"type":"array"}},"type":"object"},"TagRestApi.put":{"properties":{"id":{"type":"integer"}},"type":"object"},"TaggedObjectEntityResponseSchema":{"properties":{"changed_on":{"format":"date-time","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"creator":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"TemporaryCachePostSchema":{"properties":{"value":{"description":"Any type of JSON supported text.","type":"string"}},"required":["value"],"type":"object"},"TemporaryCachePutSchema":{"properties":{"value":{"description":"Any type of JSON supported text.","type":"string"}},"required":["value"],"type":"object"},"User":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object"},"User1":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object"},"User2":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object"},"UserResponseSchema":{"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"integer"},"is_active":{"type":"boolean"},"is_anonymous":{"type":"boolean"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object"},"ValidateSQLRequest":{"properties":{"schema":{"nullable":true,"type":"string"},"sql":{"description":"SQL statement to validate","type":"string"},"template_params":{"nullable":true,"type":"object"}},"required":["sql"],"type":"object"},"ValidateSQLResponse":{"properties":{"end_column":{"type":"integer"},"line_number":{"type":"integer"},"message":{"type":"string"},"start_column":{"type":"integer"}},"type":"object"},"ValidatorConfigJSON":{"properties":{"op":{"description":"The operation to compare with a threshold to apply to the SQL output\\n","enum":["<","<=",">",">=","==","!="],"type":"string"},"threshold":{"type":"number"}},"type":"object"},"advanced_data_type_convert_schema":{"properties":{"type":{"default":"port","type":"string"},"values":{"items":{"default":"http"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object"},"database_schemas_query_schema":{"properties":{"force":{"type":"boolean"}},"type":"object"},"database_tables_query_schema":{"properties":{"force":{"type":"boolean"},"schema_name":{"type":"string"}},"required":["schema_name"],"type":"object"},"delete_tags_schema":{"items":{"type":"string"},"type":"array"},"get_delete_ids_schema":{"items":{"type":"integer"},"type":"array"},"get_export_ids_schema":{"items":{"type":"integer"},"type":"array"},"get_fav_star_ids_schema":{"items":{"type":"integer"},"type":"array"},"get_info_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"},"get_item_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"},"get_list_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"},{"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"}},"type":"object"},"get_recent_activity_schema":{"properties":{"actions":{"items":{"type":"string"},"type":"array"},"distinct":{"type":"boolean"},"page":{"type":"number"},"page_size":{"type":"number"}},"type":"object"},"get_related_schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"queries_get_updated_since_schema":{"properties":{"last_updated_ms":{"type":"number"}},"required":["last_updated_ms"],"type":"object"},"screenshot_query_schema":{"properties":{"force":{"type":"boolean"},"thumb_size":{"items":{"type":"integer"},"type":"array"},"window_size":{"items":{"type":"integer"},"type":"array"}},"type":"object"},"sql_lab_get_results_schema":{"properties":{"key":{"type":"string"}},"required":["key"],"type":"object"},"thumbnail_query_schema":{"properties":{"force":{"type":"boolean"}},"type":"object"}},"securitySchemes":{"jwt":{"bearerFormat":"JWT","scheme":"bearer","type":"http"},"jwt_refresh":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"info":{"description":"Superset","title":"Superset","version":"v1"},"openapi":"3.0.2","paths":{"/api/v1/advanced_data_type/convert":{"get":{"parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/advanced_data_type_convert_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedDataTypeSchema"}}},"description":"AdvancedDataTypeResponse object has been returned."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Returns a AdvancedDataTypeResponse object populated with the passed in args.","tags":["Advanced Data Type"]}},"/api/v1/advanced_data_type/types":{"get":{"description":"Returns a list of available advanced data types.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"type":"string"},"type":"array"}},"type":"object"}}},"description":"a successful return of the available advanced data types has taken place."},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Advanced Data Type"]}},"/api/v1/annotation_layer/":{"delete":{"description":"Deletes multiple annotation layers in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"CSS templates bulk delete"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"get":{"description":"Get a list of Annotation layers, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/AnnotationLayerRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"post":{"description":"Create an Annotation layer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationLayerRestApi.post"}}},"description":"Annotation Layer schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/AnnotationLayerRestApi.post"}},"type":"object"}}},"description":"Annotation added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]}},"/api/v1/annotation_layer/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]}},"/api/v1/annotation_layer/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]}},"/api/v1/annotation_layer/{pk}":{"delete":{"description":"Delete Annotation layer","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"get":{"description":"Get an Annotation layer","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/AnnotationLayerRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"put":{"description":"Update an Annotation layer","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationLayerRestApi.put"}}},"description":"Annotation schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/AnnotationLayerRestApi.put"}},"type":"object"}}},"description":"Annotation changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]}},"/api/v1/annotation_layer/{pk}/annotation/":{"delete":{"description":"Deletes multiple annotation in a bulk operation.","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Annotations bulk delete"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"get":{"description":"Get a list of Annotation layers, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"description":"The annotation layer id for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"ids":{"description":"A list of annotation ids","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"$ref":"#/components/schemas/AnnotationRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Annotations"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"post":{"description":"Create an Annotation layer","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationRestApi.post"}}},"description":"Annotation schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/AnnotationRestApi.post"}},"type":"object"}}},"description":"Annotation added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]}},"/api/v1/annotation_layer/{pk}/annotation/{annotation_id}":{"delete":{"description":"Delete Annotation layer","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The annotation pk for this annotation","in":"path","name":"annotation_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"get":{"description":"Get an Annotation layer","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The annotation pk","in":"path","name":"annotation_id","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"The item id","type":"string"},"result":{"$ref":"#/components/schemas/AnnotationRestApi.get"}},"type":"object"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"put":{"description":"Update an Annotation layer","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The annotation pk for this annotation","in":"path","name":"annotation_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationRestApi.put"}}},"description":"Annotation schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/AnnotationRestApi.put"}},"type":"object"}}},"description":"Annotation changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]}},"/api/v1/assets/export/":{"get":{"description":"Returns a ZIP file with all the Superset assets (databases, datasets, charts, dashboards, saved queries) as YAML files.","responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"ZIP file"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Import/export"]}},"/api/v1/assets/import/":{"post":{"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"bundle":{"description":"upload file (ZIP or JSON)","format":"binary","type":"string"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key_password\\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key\\"}`.","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Assets import result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Import/export"]}},"/api/v1/async_event/":{"get":{"description":"Reads off of the Redis events stream, using the user\'s JWT token and optional query params for last event received.","parameters":[{"description":"Last ID received by the client","in":"query","name":"last_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"channel_id":{"type":"string"},"errors":{"items":{"type":"object"},"type":"array"},"id":{"type":"string"},"job_id":{"type":"string"},"result_url":{"type":"string"},"status":{"type":"string"},"user_id":{"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Async event results"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["AsyncEventsRestApi"]}},"/api/v1/available_domains/":{"get":{"description":"Get all available domains","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/AvailableDomainsSchema"}},"type":"object"}}},"description":"a list of available domains"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}},"security":[{"jwt":[]}],"tags":["Available Domains"]}},"/api/v1/cachekey/invalidate":{"post":{"description":"Takes a list of datasources, finds the associated cache records and invalidates them and removes the database records","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CacheInvalidationRequestSchema"}}},"description":"A list of datasources uuid or the tuples of database and datasource names","required":true},"responses":{"201":{"description":"cache was successfully invalidated"},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CacheRestApi"]}},"/api/v1/chart/":{"delete":{"description":"Deletes multiple Charts in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Charts bulk delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]},"get":{"description":"Get a list of charts, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/ChartRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]},"post":{"description":"Create a new Chart.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartRestApi.post"}}},"description":"Chart schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/ChartRestApi.post"}},"type":"object"}}},"description":"Chart added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/_info":{"get":{"description":"Several metadata information about chart API endpoints.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/data":{"post":{"description":"Takes a query context constructed in the client and returns payload data response for the given query.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartDataQueryContextSchema"}}},"description":"A query context consists of a datasource from which to fetch data and one or many query objects.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartDataResponseSchema"}}},"description":"Query result"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartDataAsyncResponseSchema"}}},"description":"Async job details"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/data/{cache_key}":{"get":{"description":"Takes a query context cache key and returns payload data response for the given query.","parameters":[{"in":"path","name":"cache_key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartDataResponseSchema"}}},"description":"Query result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/export/":{"get":{"description":"Exports multiple charts and downloads them as YAML files","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_export_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"A zip file with chart(s), dataset(s) and database(s) as YAML"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/favorite_status/":{"get":{"description":"Check favorited dashboards for current user","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_fav_star_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFavStarIdsSchema"}}},"description":"None"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/import/":{"post":{"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing charts?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key_password\\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key\\"}`.","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Chart import result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/related/{column_name}":{"get":{"description":"Get a list of all possible owners for a chart. Use `owners` has the `column_name` parameter","parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/warm_up_cache":{"put":{"description":"Warms up the cache for the chart. Note for slices a force refresh occurs. In terms of the `extra_filters` these can be obtained from records in the JSON encoded `logs.json` column associated with the `explore_json` action.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartCacheWarmUpRequestSchema"}}},"description":"Identifies the chart to warm up cache for, and any additional dashboard or filter context to use.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartCacheWarmUpResponseSchema"}}},"description":"Each chart\'s warmup status"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Warms up the cache for the chart","tags":["Charts"]}},"/api/v1/chart/{pk}":{"delete":{"description":"Deletes a Chart.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Chart delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]},"get":{"description":"Get a chart detail information.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/ChartRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]},"put":{"description":"Changes a Chart.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartRestApi.put"}}},"description":"Chart schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/ChartRestApi.put"}},"type":"object"}}},"description":"Chart changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/{pk}/cache_screenshot/":{"get":{"description":"Compute and cache a screenshot.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/screenshot_query_schema"}}},"in":"query","name":"q"}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartCacheScreenshotResponseSchema"}}},"description":"Chart async result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/{pk}/data/":{"get":{"description":"Takes a chart ID and uses the query context stored when the chart was saved to return payload data response.","parameters":[{"description":"The chart ID","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The format in which the data should be returned","in":"query","name":"format","schema":{"type":"string"}},{"description":"The type in which the data should be returned","in":"query","name":"type","schema":{"type":"string"}},{"description":"Should the queries be forced to load from the source","in":"query","name":"force","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartDataResponseSchema"}}},"description":"Query result"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartDataAsyncResponseSchema"}}},"description":"Async job details"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/{pk}/favorites/":{"delete":{"description":"Remove the chart from the user favorite list","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Chart removed from favorites"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]},"post":{"description":"Marks the chart as favorite for the current user","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Chart added to favorites"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/{pk}/screenshot/{digest}/":{"get":{"description":"Get a computed screenshot from cache.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"digest","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Chart thumbnail image"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/{pk}/thumbnail/{digest}/":{"get":{"description":"Compute or get already computed chart thumbnail from cache.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"digest","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Chart thumbnail image"},"302":{"description":"Redirects to the current digest"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/css_template/":{"delete":{"description":"Deletes multiple css templates in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"CSS templates bulk delete"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]},"get":{"description":"Get a list of CSS templates, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/CssTemplateRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]},"post":{"description":"Create a CSS template","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CssTemplateRestApi.post"}}},"description":"Model schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"$ref":"#/components/schemas/CssTemplateRestApi.post"}},"type":"object"}}},"description":"Item inserted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]}},"/api/v1/css_template/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]}},"/api/v1/css_template/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]}},"/api/v1/css_template/{pk}":{"delete":{"description":"Delete CSS template","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]},"get":{"description":"Get a CSS template","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/CssTemplateRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]},"put":{"description":"Update a CSS template","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CssTemplateRestApi.put"}}},"description":"Model schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/CssTemplateRestApi.put"}},"type":"object"}}},"description":"Item changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]}},"/api/v1/dashboard/":{"delete":{"description":"Deletes multiple Dashboards in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dashboard bulk delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"get":{"description":"Get a list of dashboards, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/DashboardRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"post":{"description":"Create a new Dashboard.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardRestApi.post"}}},"description":"Dashboard schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/DashboardRestApi.post"}},"type":"object"}}},"description":"Dashboard added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/_info":{"get":{"description":"Several metadata information about dashboard API endpoints.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/export/":{"get":{"description":"Exports multiple Dashboards and downloads them as YAML files.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_export_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Dashboard export"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/favorite_status/":{"get":{"description":"Check favorited dashboards for current user","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_fav_star_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFavStarIdsSchema"}}},"description":"None"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/import/":{"post":{"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP or JSON)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing dashboards?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key_password\\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key\\"}`.","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dashboard import result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/permalink/{key}":{"get":{"description":"Retrives dashboard state associated with a permanent link.","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"state":{"description":"The stored state","type":"object"}},"type":"object"}}},"description":"Returns the stored state."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboard Permanent Link"]}},"/api/v1/dashboard/related/{column_name}":{"get":{"description":"Get a list of all possible owners for a dashboard.","parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{dashboard_id}/filtersets":{"get":{"description":"Get a dashboard\'s list of filter sets","parameters":[{"description":"The id of the dashboard","in":"path","name":"dashboard_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"description":{"description":"A description field of the filter set","type":"string"},"json_metadata":{"description":"metadata of the filter set","type":"string"},"name":{"description":"Name of the Filter set","type":"string"},"owner_id":{"description":"A description field of the filter set","type":"integer"},"owner_type":{"description":"the Type of the owner ( Dashboard/User)","type":"integer"},"parameters":{"description":"JSON schema defining the needed parameters"}},"type":"object"},"type":"array"}}},"description":"FilterSets"},"302":{"description":"Redirects to the current digest"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}},"security":[{"jwt":[]}],"tags":["FilterSetRestApi"]},"post":{"description":"Create a new Dashboard\'s Filter Set.","parameters":[{"description":"The id of the dashboard","in":"path","name":"dashboard_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterSetRestApi.post"}}},"description":"Filter set schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/FilterSetRestApi.post"}},"type":"object"}}},"description":"Filter set added"},"302":{"description":"Redirects to the current digest"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["FilterSetRestApi"]}},"/api/v1/dashboard/{dashboard_id}/filtersets/{pk}":{"delete":{"description":"Deletes a Dashboard.","parameters":[{"in":"path","name":"dashboard_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Filter set deleted"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["FilterSetRestApi"]},"put":{"description":"Changes a Dashboard\'s Filter set.","parameters":[{"in":"path","name":"dashboard_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterSetRestApi.put"}}},"description":"Filter set schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/FilterSetRestApi.put"}},"type":"object"}}},"description":"Filter set changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["FilterSetRestApi"]}},"/api/v1/dashboard/{id_or_slug}":{"get":{"description":"Get a dashboard detail information.","parameters":[{"description":"Either the id of the dashboard, or its slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/DashboardGetResponseSchema"}},"type":"object"}}},"description":"Dashboard"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{id_or_slug}/charts":{"get":{"description":"Get the chart definitions for a given dashboard","parameters":[{"in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"$ref":"#/components/schemas/ChartEntityResponseSchema"},"type":"array"}},"type":"object"}}},"description":"Dashboard chart definitions"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{id_or_slug}/copy/":{"post":{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardCopySchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"last_modified_time":{"type":"number"}},"type":"object"}}},"description":"Id of new dashboard and last modified time"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Makes a copy of an existing dashboard","tags":["Dashboards"]}},"/api/v1/dashboard/{id_or_slug}/datasets":{"get":{"description":"Returns a list of a dashboard\'s datasets. Each dataset includes only the information necessary to render the dashboard\'s charts.","parameters":[{"description":"Either the id of the dashboard, or its slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"$ref":"#/components/schemas/DashboardDatasetSchema"},"type":"array"}},"type":"object"}}},"description":"Dashboard dataset definitions"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{id_or_slug}/embedded":{"delete":{"description":"Removes a dashboard\'s embedded configuration.","parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Successfully removed the configuration"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"get":{"description":"Returns the dashboard\'s embedded configuration","parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/EmbeddedDashboardResponseSchema"}},"type":"object"}}},"description":"Result contains the embedded dashboard config"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"post":{"description":"Sets a dashboard\'s embedded configuration.","parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedDashboardConfig"}}},"description":"The embedded configuration to set","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/EmbeddedDashboardResponseSchema"}},"type":"object"}}},"description":"Successfully set the configuration"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"put":{"description":"Sets a dashboard\'s embedded configuration.","parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedDashboardConfig"}}},"description":"The embedded configuration to set","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/EmbeddedDashboardResponseSchema"}},"type":"object"}}},"description":"Successfully set the configuration"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{pk}":{"delete":{"description":"Deletes a Dashboard.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dashboard deleted"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"put":{"description":"Changes a Dashboard.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardRestApi.put"}}},"description":"Dashboard schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"last_modified_time":{"type":"number"},"result":{"$ref":"#/components/schemas/DashboardRestApi.put"}},"type":"object"}}},"description":"Dashboard changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{pk}/favorites/":{"delete":{"description":"Remove the dashboard from the user favorite list","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Dashboard removed from favorites"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"post":{"description":"Marks the dashboard as favorite for the current user","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Dashboard added to favorites"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{pk}/filter_state":{"post":{"description":"Stores a new value.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryCachePostSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the value.","type":"string"}},"type":"object"}}},"description":"The value was stored successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboard Filter State"]}},"/api/v1/dashboard/{pk}/filter_state/{key}":{"delete":{"description":"Deletes a value.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The value key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"description":"The result of the operation","type":"string"}},"type":"object"}}},"description":"Deleted the stored value."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboard Filter State"]},"get":{"description":"Retrives a value.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"value":{"description":"The stored value","type":"string"}},"type":"object"}}},"description":"Returns the stored value."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboard Filter State"]},"put":{"description":"Updates an existing value.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"key","required":true,"schema":{"type":"string"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryCachePutSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the value.","type":"string"}},"type":"object"}}},"description":"The value was stored successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboard Filter State"]}},"/api/v1/dashboard/{pk}/permalink":{"post":{"description":"Stores a new permanent link.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardPermalinkStateSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the permanent link data.","type":"string"},"url":{"description":"permanent link.","type":"string"}},"type":"object"}}},"description":"The permanent link was stored successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboard Permanent Link"]}},"/api/v1/dashboard/{pk}/thumbnail/{digest}/":{"get":{"description":"Compute async or get already computed dashboard thumbnail from cache.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"A hex digest that makes this dashboard unique","in":"path","name":"digest","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/thumbnail_query_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Dashboard thumbnail image"},"202":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Thumbnail does not exist on cache, fired async to compute"},"302":{"description":"Redirects to the current digest"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/database/":{"get":{"description":"Get a list of models","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/DatabaseRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]},"post":{"description":"Create a new Database.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseRestApi.post"}}},"description":"Database schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/DatabaseRestApi.post"}},"type":"object"}}},"description":"Database added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/available/":{"get":{"description":"Get names of databases currently available","responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"available_drivers":{"description":"Installed drivers for the engine","items":{"type":"string"},"type":"array"},"default_driver":{"description":"Default driver for the engine","type":"string"},"engine":{"description":"Name of the SQLAlchemy engine","type":"string"},"engine_information":{"description":"Dict with public properties form the DB Engine","properties":{"disable_ssh_tunneling":{"description":"Whether the engine supports SSH Tunnels","type":"boolean"},"supports_file_upload":{"description":"Whether the engine supports file uploads","type":"boolean"}},"type":"object"},"name":{"description":"Name of the database","type":"string"},"parameters":{"description":"JSON schema defining the needed parameters","type":"object"},"preferred":{"description":"Is the database preferred?","type":"boolean"},"sqlalchemy_uri_placeholder":{"description":"Example placeholder for the SQLAlchemy URI","type":"string"}},"type":"object"},"type":"array"}}},"description":"Database names"},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/export/":{"get":{"description":"Download database(s) and associated dataset(s) as a zip file","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_export_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"A zip file with database(s) and dataset(s) as YAML"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/import/":{"post":{"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing databases?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key_password\\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key\\"}`.","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Database import result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/test_connection/":{"post":{"description":"Tests a database connection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseTestConnectionSchema"}}},"description":"Database schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Database Test Connection"},"400":{"$ref":"#/components/responses/400"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/validate_parameters/":{"post":{"description":"Validates parameters used to connect to a database","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseValidateParametersSchema"}}},"description":"DB-specific parameters","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Database Test Connection"},"400":{"$ref":"#/components/responses/400"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}":{"delete":{"description":"Deletes a Database.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Database deleted"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]},"get":{"description":"Get a database","parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Database"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]},"put":{"description":"Changes a Database.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseRestApi.put"}}},"description":"Database schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/DatabaseRestApi.put"}},"type":"object"}}},"description":"Database changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/connection":{"get":{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseConnectionSchema"}}},"description":"Database with connection info"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Get a database connection info","tags":["Database"]}},"/api/v1/database/{pk}/function_names/":{"get":{"description":"Get function names supported by a database","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseFunctionNamesResponse"}}},"description":"Query result"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/related_objects/":{"get":{"description":"Get charts and dashboards count associated to a database","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseRelatedObjectsResponse"}}},"description":"Query result"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/schemas/":{"get":{"description":"Get all schemas from a database","parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/database_schemas_query_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemasResponseSchema"}}},"description":"A List of all schemas from the database"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/schemas_access_for_file_upload/":{"get":{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseSchemaAccessForFileUploadResponse"}}},"description":"The list of the database schemas where to upload information"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"The list of the database schemas where to upload information","tags":["Database"]}},"/api/v1/database/{pk}/select_star/{table_name}/":{"get":{"description":"Get database select star for table","parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"path","name":"table_name","required":true,"schema":{"type":"string"}},{"description":"Table schema","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectStarResponseSchema"}}},"description":"SQL statement for a select star for table"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/select_star/{table_name}/{schema_name}/":{"get":{"description":"Get database select star for table","parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"path","name":"table_name","required":true,"schema":{"type":"string"}},{"description":"Table schema","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectStarResponseSchema"}}},"description":"SQL statement for a select star for table"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/ssh_tunnel/":{"delete":{"description":"Deletes a SSH Tunnel.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"SSH Tunnel deleted"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/table/{table_name}/{schema_name}/":{"get":{"description":"Get database table metadata","parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"path","name":"table_name","required":true,"schema":{"type":"string"}},{"description":"Table schema","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableMetadataResponseSchema"}}},"description":"Table metadata information"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/table_extra/{table_name}/{schema_name}/":{"get":{"description":"Response depends on each DB engine spec normally focused on partitions","parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"path","name":"table_name","required":true,"schema":{"type":"string"}},{"description":"Table schema","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableExtraMetadataResponseSchema"}}},"description":"Table extra metadata information"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Get table extra metadata","tags":["Database"]}},"/api/v1/database/{pk}/tables/":{"get":{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/database_tables_query_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"result":{"description":"A List of tables for given database","items":{"$ref":"#/components/schemas/DatabaseTablesResponse"},"type":"array"}},"type":"object"}}},"description":"Tables list"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Get a list of tables for given database","tags":["Database"]}},"/api/v1/database/{pk}/validate_sql/":{"post":{"description":"Validates arbitrary SQL.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateSQLRequest"}}},"description":"Validate SQL request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A List of SQL errors found on the statement","items":{"$ref":"#/components/schemas/ValidateSQLResponse"},"type":"array"}},"type":"object"}}},"description":"Validation result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Validates that arbitrary sql is acceptable for the given database","tags":["Database"]}},"/api/v1/dataset/":{"delete":{"description":"Deletes multiple Datasets in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dataset bulk delete"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]},"get":{"description":"Get a list of models","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/DatasetRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]},"post":{"description":"Create a new Dataset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetRestApi.post"}}},"description":"Dataset schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/DatasetRestApi.post"}},"type":"object"}}},"description":"Dataset added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/distinct/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistincResponseSchema"}}},"description":"Distinct field data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/duplicate":{"post":{"description":"Duplicates a Dataset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDuplicateSchema"}}},"description":"Dataset schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/DatasetDuplicateSchema"}},"type":"object"}}},"description":"Dataset duplicated"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/export/":{"get":{"description":"Exports multiple datasets and downloads them as YAML files","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_export_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Dataset export"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/get_or_create/":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateDatasetSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"table_id":{"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"The ID of the table"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Retrieve a table by name, or create it if it does not exist","tags":["Datasets"]}},"/api/v1/dataset/import/":{"post":{"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP or YAML)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing datasets?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key_password\\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key\\"}`.","type":"string"},"sync_columns":{"description":"sync columns?","type":"boolean"},"sync_metrics":{"description":"sync metrics?","type":"boolean"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dataset import result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/warm_up_cache":{"put":{"description":"Warms up the cache for the table. Note for slices a force refresh occurs. In terms of the `extra_filters` these can be obtained from records in the JSON encoded `logs.json` column associated with the `explore_json` action.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetCacheWarmUpRequestSchema"}}},"description":"Identifies the database and table to warm up cache for, and any additional dashboard or filter context to use.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetCacheWarmUpResponseSchema"}}},"description":"Each chart\'s warmup status"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Warms up the cache for each chart powered by the given table","tags":["Datasets"]}},"/api/v1/dataset/{pk}":{"delete":{"description":"Deletes a Dataset","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dataset delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]},"get":{"description":"Get an item model","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/DatasetRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]},"put":{"description":"Changes a Dataset","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"query","name":"override_columns","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetRestApi.put"}}},"description":"Dataset schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/DatasetRestApi.put"}},"type":"object"}}},"description":"Dataset changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/{pk}/column/{column_id}":{"delete":{"description":"Delete a Dataset column","parameters":[{"description":"The dataset pk for this column","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The column id for this dataset","in":"path","name":"column_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Column deleted"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/{pk}/metric/{metric_id}":{"delete":{"description":"Delete a Dataset metric","parameters":[{"description":"The dataset pk for this column","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The metric id for this dataset","in":"path","name":"metric_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Metric deleted"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/{pk}/refresh":{"put":{"description":"Refreshes and updates columns of a dataset","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dataset delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/{pk}/related_objects":{"get":{"description":"Get charts and dashboards count associated to a dataset","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetRelatedObjectsResponse"}}},"description":"Query result"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/datasource/{datasource_type}/{datasource_id}/column/{column_name}/values/":{"get":{"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"}},{"description":"The name of the column to get values for","in":"path","name":"column_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"type":"array"}},"type":"object"}}},"description":"A List of distinct values for the column"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Get possible values for a datasource column","tags":["Datasources"]}},"/api/v1/embedded_dashboard/{uuid}":{"get":{"description":"Get a report schedule log","parameters":[{"description":"The embedded configuration uuid","in":"path","name":"uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/EmbeddedDashboardResponseSchema"}},"type":"object"}}},"description":"Result contains the embedded dashboard configuration"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Embedded Dashboard"]}},"/api/v1/explore/":{"get":{"description":"Assembles Explore related information (form_data, slice, dataset)\\\\n in a single endpoint.<br/><br/>\\\\nThe information can be assembled from:<br/> - The cache using a form_data_key<br/> - The metadata database using a permalink_key<br/> - Build from scratch using dataset or slice identifiers.","parameters":[{"in":"query","name":"form_data_key","schema":{"type":"string"}},{"in":"query","name":"permalink_key","schema":{"type":"string"}},{"in":"query","name":"slice_id","schema":{"type":"integer"}},{"in":"query","name":"datasource_id","schema":{"type":"integer"}},{"in":"query","name":"datasource_type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExploreContextSchema"}}},"description":"Returns the initial context."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Assembles Explore related information (form_data, slice, dataset)\\\\n in a single endpoint.","tags":["Explore"]}},"/api/v1/explore/form_data":{"post":{"description":"Stores a new form_data.","parameters":[{"in":"query","name":"tab_id","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormDataPostSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the form_data.","type":"string"}},"type":"object"}}},"description":"The form_data was stored successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Explore Form Data"]}},"/api/v1/explore/form_data/{key}":{"delete":{"description":"Deletes a form_data.","parameters":[{"description":"The form_data key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"description":"The result of the operation","type":"string"}},"type":"object"}}},"description":"Deleted the stored form_data."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Explore Form Data"]},"get":{"description":"Retrives a form_data.","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"form_data":{"description":"The stored form_data","type":"string"}},"type":"object"}}},"description":"Returns the stored form_data."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Explore Form Data"]},"put":{"description":"Updates an existing form_data.","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormDataPutSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the form_data.","type":"string"}},"type":"object"}}},"description":"The form_data was stored successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Explore Form Data"]}},"/api/v1/explore/permalink":{"post":{"description":"Stores a new permanent link.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExplorePermalinkStateSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the permanent link data.","type":"string"},"url":{"description":"permanent link.","type":"string"}},"type":"object"}}},"description":"The permanent link was stored successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Explore Permanent Link"]}},"/api/v1/explore/permalink/{key}":{"get":{"description":"Retrives chart state associated with a permanent link.","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"state":{"description":"The stored state","type":"object"}},"type":"object"}}},"description":"Returns the stored form_data."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Explore Permanent Link"]}},"/api/v1/log/":{"get":{"description":"Get a list of models","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/LogRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["LogRestApi"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogRestApi.post"}}},"description":"Model schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"$ref":"#/components/schemas/LogRestApi.post"}},"type":"object"}}},"description":"Item inserted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["LogRestApi"]}},"/api/v1/log/recent_activity/":{"get":{"parameters":[{"description":"The id of the user","in":"path","name":"user_id","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_recent_activity_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecentActivityResponseSchema"}}},"description":"A List of recent activity objects"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Get recent activity data for a user","tags":["LogRestApi"]}},"/api/v1/log/{pk}":{"get":{"description":"Get an item model","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/LogRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["LogRestApi"]}},"/api/v1/me/":{"get":{"description":"Returns the user object corresponding to the agent making the request, or returns a 401 error if the user is unauthenticated.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/UserResponseSchema"}},"type":"object"}}},"description":"The current user"},"401":{"$ref":"#/components/responses/401"}},"tags":["Current User"]}},"/api/v1/me/roles/":{"get":{"description":"Returns the user roles corresponding to the agent making the request, or returns a 401 error if the user is unauthenticated.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/UserResponseSchema"}},"type":"object"}}},"description":"The current user"},"401":{"$ref":"#/components/responses/401"}},"tags":["Current User"]}},"/api/v1/menu/":{"get":{"description":"Get the menu data structure. Returns a forest like structure with the menu the user has access to","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"Menu items in a forest like data structure","items":{"properties":{"childs":{"items":{"type":"object"},"type":"array"},"icon":{"description":"Icon name to show for this menu item","type":"string"},"label":{"description":"Pretty name for the menu item","type":"string"},"name":{"description":"The internal menu item name, maps to permission_name","type":"string"},"url":{"description":"The URL for the menu item","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Get menu data"},"401":{"$ref":"#/components/responses/401"}},"security":[{"jwt":[]}],"tags":["Menu"]}},"/api/v1/query/":{"get":{"description":"Get a list of queries, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/QueryRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/query/distinct/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistincResponseSchema"}}},"description":"Distinct field data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/query/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/query/stop":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopQuerySchema"}}},"description":"Stop query schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"}}},"description":"Query stopped"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Manually stop a query with client_id","tags":["Queries"]}},"/api/v1/query/updated_since":{"get":{"parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries_get_updated_since_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A List of queries that changed after last_updated_ms","items":{"$ref":"#/components/schemas/QueryRestApi.get"},"type":"array"}},"type":"object"}}},"description":"Queries list"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Get a list of queries that changed after last_updated_ms","tags":["Queries"]}},"/api/v1/query/{pk}":{"get":{"description":"Get query detail information.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/QueryRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/report/":{"delete":{"description":"Deletes multiple report schedules in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Report Schedule bulk delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]},"get":{"description":"Get a list of report schedules, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/ReportScheduleRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]},"post":{"description":"Create a report schedule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportScheduleRestApi.post"}}},"description":"Report Schedule schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/ReportScheduleRestApi.post"}},"type":"object"}}},"description":"Report schedule added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]}},"/api/v1/report/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]}},"/api/v1/report/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]}},"/api/v1/report/{pk}":{"delete":{"description":"Delete a report schedule","parameters":[{"description":"The report schedule pk","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]},"get":{"description":"Get a report schedule","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/ReportScheduleRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]},"put":{"description":"Update a report schedule","parameters":[{"description":"The Report Schedule pk","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportScheduleRestApi.put"}}},"description":"Report Schedule schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/ReportScheduleRestApi.put"}},"type":"object"}}},"description":"Report Schedule changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]}},"/api/v1/report/{pk}/log/":{"get":{"description":"Get a list of report schedule logs, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"description":"The report schedule id for these logs","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"ids":{"description":"A list of log ids","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"$ref":"#/components/schemas/ReportExecutionLogRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from logs"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]}},"/api/v1/report/{pk}/log/{log_id}":{"get":{"description":"Get a report schedule log","parameters":[{"description":"The report schedule pk for log","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The log pk","in":"path","name":"log_id","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"The log id","type":"string"},"result":{"$ref":"#/components/schemas/ReportExecutionLogRestApi.get"}},"type":"object"}}},"description":"Item log"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]}},"/api/v1/rowlevelsecurity/":{"delete":{"description":"Deletes multiple RLS rules in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"RLS Rule bulk delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]},"get":{"description":"Get a list of models","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/RLSRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]},"post":{"description":"Create a new RLS Rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RLSRestApi.post"}}},"description":"RLS schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/RLSRestApi.post"}},"type":"object"}}},"description":"RLS Rule added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]}},"/api/v1/rowlevelsecurity/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]}},"/api/v1/rowlevelsecurity/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]}},"/api/v1/rowlevelsecurity/{pk}":{"delete":{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]},"get":{"description":"Get an item model","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/RLSRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]},"put":{"description":"Updates an RLS Rule","parameters":[{"description":"The Rule pk","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RLSRestApi.put"}}},"description":"RLS schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/RLSRestApi.put"}},"type":"object"}}},"description":"Rule changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]}},"/api/v1/saved_query/":{"delete":{"description":"Deletes multiple saved queries in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Saved queries bulk delete"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]},"get":{"description":"Get a list of saved queries, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/SavedQueryRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]},"post":{"description":"Create a saved query","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedQueryRestApi.post"}}},"description":"Model schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"$ref":"#/components/schemas/SavedQueryRestApi.post"}},"type":"object"}}},"description":"Item inserted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/saved_query/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/saved_query/distinct/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistincResponseSchema"}}},"description":"Distinct field data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/saved_query/export/":{"get":{"description":"Exports multiple saved queries and downloads them as YAML files","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_export_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"A zip file with saved query(ies) and database(s) as YAML"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/saved_query/import/":{"post":{"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing saved queries?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key_password\\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key\\"}`.","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Saved Query import result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/saved_query/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/saved_query/{pk}":{"delete":{"description":"Delete saved query","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]},"get":{"description":"Get a saved query","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/SavedQueryRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]},"put":{"description":"Update a saved query","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedQueryRestApi.put"}}},"description":"Model schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/SavedQueryRestApi.put"}},"type":"object"}}},"description":"Item changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/security/csrf_token/":{"get":{"description":"Fetch the CSRF token","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"}}},"description":"Result contains the CSRF token"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Security"]}},"/api/v1/security/guest_token/":{"post":{"description":"Fetches a guest token","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuestTokenCreate"}}},"description":"Parameters for the guest token","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"token":{"type":"string"}},"type":"object"}}},"description":"Result contains the guest token"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Security"]}},"/api/v1/security/login":{"post":{"description":"Authenticate and get a JWT access and refresh token","requestBody":{"content":{"application/json":{"schema":{"properties":{"password":{"description":"The password for authentication","example":"complex-password","type":"string"},"provider":{"description":"Choose an authentication provider","enum":["db","ldap"],"example":"db","type":"string"},"refresh":{"description":"If true a refresh token is provided also","example":true,"type":"boolean"},"username":{"description":"The username for authentication","example":"admin","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"access_token":{"type":"string"},"refresh_token":{"type":"string"}},"type":"object"}}},"description":"Authentication Successful"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"tags":["Security"]}},"/api/v1/security/refresh":{"post":{"description":"Use the refresh token to get a new JWT access token","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"access_token":{"description":"A new refreshed access token","type":"string"}},"type":"object"}}},"description":"Refresh Successful"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt_refresh":[]}],"tags":["Security"]}},"/api/v1/sqllab/estimate/":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EstimateQueryCostSchema"}}},"description":"SQL query and params","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Query estimation result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Estimates the SQL query execution cost","tags":["SQL Lab"]}},"/api/v1/sqllab/execute/":{"post":{"description":"Starts the execution of a SQL query","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePayloadSchema"}}},"description":"SQL query and params","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryExecutionResponseSchema"}}},"description":"Query execution result"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryExecutionResponseSchema"}}},"description":"Query execution result, query still running"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["SQL Lab"]}},"/api/v1/sqllab/export/{client_id}/":{"get":{"parameters":[{"description":"The SQL query result identifier","in":"path","name":"client_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"text/csv":{"schema":{"type":"string"}}},"description":"SQL query results"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Exports the SQL query results to a CSV","tags":["SQL Lab"]}},"/api/v1/sqllab/results/":{"get":{"parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sql_lab_get_results_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryExecutionResponseSchema"}}},"description":"SQL query execution result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"410":{"$ref":"#/components/responses/410"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Gets the result of a SQL query execution","tags":["SQL Lab"]}},"/api/v1/tag/":{"delete":{"description":"Deletes multiple Tags. This will remove all tagged objects with this tag","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete_tags_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Deletes multiple Tags"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]},"get":{"description":"Get a list of tags, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/TagRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRestApi.post"}}},"description":"Model schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"$ref":"#/components/schemas/TagRestApi.post"}},"type":"object"}}},"description":"Item inserted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/_info":{"get":{"description":"Several metadata information about tag API endpoints.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/favorite_status/":{"get":{"description":"Check favorited dashboards for current user","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_fav_star_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFavStarIdsSchema"}}},"description":"None"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/get_objects/":{"get":{"description":"Gets all objects associated with a Tag.","parameters":[{"in":"path","name":"tag_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"$ref":"#/components/schemas/TaggedObjectEntityResponseSchema"},"type":"array"}},"type":"object"}}},"description":"List of tagged objects associated with a Tag"},"302":{"description":"Redirects to the current digest"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/{object_type}/{object_id}/":{"post":{"description":"Add tags to an object..","parameters":[{"in":"path","name":"object_type","required":true,"schema":{"type":"integer"}},{"in":"path","name":"object_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"tags":{"description":"list of tag names to add to object","items":{"type":"string"},"type":"array"}},"type":"object"}}},"description":"Tag schema","required":true},"responses":{"201":{"description":"Tag added"},"302":{"description":"Redirects to the current digest"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/{object_type}/{object_id}/{tag}/":{"delete":{"description":"Deletes a Tagged Object.","parameters":[{"in":"path","name":"tag","required":true,"schema":{"type":"string"}},{"in":"path","name":"object_type","required":true,"schema":{"type":"integer"}},{"in":"path","name":"object_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Chart delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/{pk}":{"delete":{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]},"get":{"description":"Get a tag detail information.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/TagRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]},"put":{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRestApi.put"}}},"description":"Model schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/TagRestApi.put"}},"type":"object"}}},"description":"Item changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/{pk}/favorites/":{"delete":{"description":"Remove the tag from the user favorite list","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Tag removed from favorites"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]},"post":{"description":"Marks the tag as favorite for the current user","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Tag added to favorites"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/{version}/_openapi":{"get":{"description":"Get the OpenAPI spec for a specific API version","parameters":[{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"The OpenAPI spec"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["OpenApi"]}}},"servers":[{"url":"http://localhost:8088"}]}');var p=s(55784);const c={title:"API",hide_title:!0,sidebar_position:9},l=void 0,m={unversionedId:"api",id:"api",title:"API",description:"API",source:"@site/docs/api.mdx",sourceDirName:".",slug:"/api",permalink:"/docs/api",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/api.mdx",tags:[],version:"current",sidebarPosition:9,frontMatter:{title:"API",hide_title:!0,sidebar_position:9},sidebar:"tutorialSidebar",previous:{title:"Frequently Asked Questions",permalink:"/docs/frequently-asked-questions"},next:{title:"Role based Access",permalink:"/docs/security/"}},d={};s.g.Buffer=n.Buffer;const u=[{value:"API",id:"api",level:2}],h={toc:u},y="wrapper";function g(e){let{components:t,...s}=e;return(0,a.kt)(y,(0,r.Z)({},h,s,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"api"},"API"),(0,a.kt)("p",null,"Superset's public ",(0,a.kt)("strong",{parentName:"p"},"REST API")," follows the\n",(0,a.kt)("a",{parentName:"p",href:"https://swagger.io/specification/"},"OpenAPI specification"),", and is\ndocumented here. The docs bellow are generated using\n",(0,a.kt)("a",{parentName:"p",href:"https://www.npmjs.com/package/swagger-ui-react"},"Swagger React UI"),"."),(0,a.kt)(p.Z,{type:"info",message:(0,a.kt)("div",null,(0,a.kt)("strong",null,"NOTE! "),"You can find an interactive version of this documentation on your local Superset instance at ",(0,a.kt)("strong",null,"/swagger/v1")," (unless disabled)"),mdxType:"Alert"}),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("hr",null),(0,a.kt)("div",{className:"swagger-container"},(0,a.kt)(o.Z,{spec:i,mdxType:"SwaggerUI"})))}g.isMDXComponent=!0},24654:()=>{}}]);
\ No newline at end of file
+(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[7600],{58623:(e,t,s)=>{"use strict";s.r(t),s.d(t,{assets:()=>d,contentTitle:()=>l,default:()=>g,frontMatter:()=>c,metadata:()=>m,toc:()=>u});var r=s(83117),a=(s(67294),s(3905)),n=s(48764),o=s(31156);const i=JSON.parse('{"components":{"responses":{"400":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Not found"},"410":{"content":{"application/json":{"schema":{"properties":{"errors":{"items":{"properties":{"error_type":{"enum":["FRONTEND_CSRF_ERROR","FRONTEND_NETWORK_ERROR","FRONTEND_TIMEOUT_ERROR","GENERIC_DB_ENGINE_ERROR","COLUMN_DOES_NOT_EXIST_ERROR","TABLE_DOES_NOT_EXIST_ERROR","SCHEMA_DOES_NOT_EXIST_ERROR","CONNECTION_INVALID_USERNAME_ERROR","CONNECTION_INVALID_PASSWORD_ERROR","CONNECTION_INVALID_HOSTNAME_ERROR","CONNECTION_PORT_CLOSED_ERROR","CONNECTION_INVALID_PORT_ERROR","CONNECTION_HOST_DOWN_ERROR","CONNECTION_ACCESS_DENIED_ERROR","CONNECTION_UNKNOWN_DATABASE_ERROR","CONNECTION_DATABASE_PERMISSIONS_ERROR","CONNECTION_MISSING_PARAMETERS_ERROR","OBJECT_DOES_NOT_EXIST_ERROR","SYNTAX_ERROR","CONNECTION_DATABASE_TIMEOUT","VIZ_GET_DF_ERROR","UNKNOWN_DATASOURCE_TYPE_ERROR","FAILED_FETCHING_DATASOURCE_INFO_ERROR","TABLE_SECURITY_ACCESS_ERROR","DATASOURCE_SECURITY_ACCESS_ERROR","DATABASE_SECURITY_ACCESS_ERROR","QUERY_SECURITY_ACCESS_ERROR","MISSING_OWNERSHIP_ERROR","USER_ACTIVITY_SECURITY_ACCESS_ERROR","BACKEND_TIMEOUT_ERROR","DATABASE_NOT_FOUND_ERROR","MISSING_TEMPLATE_PARAMS_ERROR","INVALID_TEMPLATE_PARAMS_ERROR","RESULTS_BACKEND_NOT_CONFIGURED_ERROR","DML_NOT_ALLOWED_ERROR","INVALID_CTAS_QUERY_ERROR","INVALID_CVAS_QUERY_ERROR","SQLLAB_TIMEOUT_ERROR","RESULTS_BACKEND_ERROR","ASYNC_WORKERS_ERROR","ADHOC_SUBQUERY_NOT_ALLOWED_ERROR","GENERIC_COMMAND_ERROR","GENERIC_BACKEND_ERROR","INVALID_PAYLOAD_FORMAT_ERROR","INVALID_PAYLOAD_SCHEMA_ERROR","REPORT_NOTIFICATION_ERROR"],"type":"string"},"extra":{"type":"object"},"level":{"enum":["info","warning","error"],"type":"string"},"message":{"type":"string"}},"type":"object"},"type":"array"},"message":{"type":"string"}},"type":"object"}}},"description":"Gone"},"422":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Could not process entity"},"500":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Fatal error"}},"schemas":{"AdvancedDataTypeSchema":{"properties":{"display_value":{"description":"The string representation of the parsed values","type":"string"},"error_message":{"type":"string"},"valid_filter_operators":{"items":{"type":"string"},"type":"array"},"values":{"items":{"description":"parsed value (can be any value)","type":"string"},"type":"array"}},"type":"object"},"AnnotationLayer":{"properties":{"annotationType":{"description":"Type of annotation layer","enum":["FORMULA","INTERVAL","EVENT","TIME_SERIES"],"type":"string"},"color":{"description":"Layer color","nullable":true,"type":"string"},"descriptionColumns":{"description":"Columns to use as the description. If none are provided, all will be shown.","items":{"type":"string"},"type":"array"},"hideLine":{"description":"Should line be hidden. Only applies to line annotations","nullable":true,"type":"boolean"},"intervalEndColumn":{"description":"Column containing end of interval. Only applies to interval layers","nullable":true,"type":"string"},"name":{"description":"Name of layer","type":"string"},"opacity":{"description":"Opacity of layer","enum":["","opacityLow","opacityMedium","opacityHigh"],"nullable":true,"type":"string"},"overrides":{"additionalProperties":{"nullable":true},"description":"which properties should be overridable","nullable":true,"type":"object"},"show":{"description":"Should the layer be shown","type":"boolean"},"showLabel":{"description":"Should the label always be shown","nullable":true,"type":"boolean"},"showMarkers":{"description":"Should markers be shown. Only applies to line annotations.","type":"boolean"},"sourceType":{"description":"Type of source for annotation data","enum":["","line","NATIVE","table"],"type":"string"},"style":{"description":"Line style. Only applies to time-series annotations","enum":["dashed","dotted","solid","longDashed"],"type":"string"},"timeColumn":{"description":"Column with event date or interval start date","nullable":true,"type":"string"},"titleColumn":{"description":"Column with title","nullable":true,"type":"string"},"value":{"description":"For formula annotations, this contains the formula. For other types, this is the primary key of the source object."},"width":{"description":"Width of annotation line","minimum":0,"type":"number"}},"required":["name","show","showMarkers","value"],"type":"object"},"AnnotationLayerRestApi.get":{"properties":{"descr":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"AnnotationLayerRestApi.get_list":{"properties":{"changed_by":{"$ref":"#/components/schemas/AnnotationLayerRestApi.get_list.User1"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/AnnotationLayerRestApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"descr":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"AnnotationLayerRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"AnnotationLayerRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"AnnotationLayerRestApi.post":{"properties":{"descr":{"description":"Give a description for this annotation layer","nullable":true,"type":"string"},"name":{"description":"The annotation layer name","maxLength":250,"minLength":1,"type":"string"}},"required":["name"],"type":"object"},"AnnotationLayerRestApi.put":{"properties":{"descr":{"description":"Give a description for this annotation layer","type":"string"},"name":{"description":"The annotation layer name","maxLength":250,"minLength":1,"type":"string"}},"type":"object"},"AnnotationRestApi.get":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"},"layer":{"$ref":"#/components/schemas/AnnotationRestApi.get.AnnotationLayer"},"long_descr":{"nullable":true,"type":"string"},"short_descr":{"maxLength":500,"nullable":true,"type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"}},"required":["layer"],"type":"object"},"AnnotationRestApi.get.AnnotationLayer":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"AnnotationRestApi.get_list":{"properties":{"changed_by":{"$ref":"#/components/schemas/AnnotationRestApi.get_list.User1"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/AnnotationRestApi.get_list.User"},"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"long_descr":{"nullable":true,"type":"string"},"short_descr":{"maxLength":500,"nullable":true,"type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"}},"type":"object"},"AnnotationRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object"},"AnnotationRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"}},"required":["first_name"],"type":"object"},"AnnotationRestApi.post":{"properties":{"end_dttm":{"description":"The annotation end date time","format":"date-time","type":"string"},"json_metadata":{"description":"JSON metadata","nullable":true,"type":"string"},"long_descr":{"description":"A long description","nullable":true,"type":"string"},"short_descr":{"description":"A short description","maxLength":500,"minLength":1,"type":"string"},"start_dttm":{"description":"The annotation start date time","format":"date-time","type":"string"}},"required":["end_dttm","short_descr","start_dttm"],"type":"object"},"AnnotationRestApi.put":{"properties":{"end_dttm":{"description":"The annotation end date time","format":"date-time","type":"string"},"json_metadata":{"description":"JSON metadata","nullable":true,"type":"string"},"long_descr":{"description":"A long description","nullable":true,"type":"string"},"short_descr":{"description":"A short description","maxLength":500,"minLength":1,"type":"string"},"start_dttm":{"description":"The annotation start date time","format":"date-time","type":"string"}},"type":"object"},"AvailableDomainsSchema":{"properties":{"domains":{"items":{"type":"string"},"type":"array"}},"type":"object"},"CacheInvalidationRequestSchema":{"properties":{"datasource_uids":{"description":"The uid of the dataset/datasource this new chart will use. A complete datasource identification needs `datasouce_uid` ","items":{"type":"string"},"type":"array"},"datasources":{"description":"A list of the data source and database names","items":{"$ref":"#/components/schemas/Datasource"},"type":"array"}},"type":"object"},"CacheRestApi.get":{"properties":{"id":{"type":"integer"}},"type":"object"},"CacheRestApi.get_list":{"properties":{"id":{"type":"integer"}},"type":"object"},"CacheRestApi.post":{"properties":{"id":{"type":"integer"}},"type":"object"},"CacheRestApi.put":{"properties":{"id":{"type":"integer"}},"type":"object"},"ChartCacheScreenshotResponseSchema":{"properties":{"cache_key":{"description":"The cache key","type":"string"},"chart_url":{"description":"The url to render the chart","type":"string"},"image_url":{"description":"The url to fetch the screenshot","type":"string"}},"type":"object"},"ChartCacheWarmUpRequestSchema":{"properties":{"chart_id":{"description":"The ID of the chart to warm up cache for","type":"integer"},"dashboard_id":{"description":"The ID of the dashboard to get filters for when warming cache","type":"integer"},"extra_filters":{"description":"Extra filters to apply when warming up cache","type":"string"}},"required":["chart_id"],"type":"object"},"ChartCacheWarmUpResponseSchema":{"properties":{"result":{"description":"A list of each chart\'s warmup status and errors if any","items":{"$ref":"#/components/schemas/ChartCacheWarmUpResponseSingle"},"type":"array"}},"type":"object"},"ChartCacheWarmUpResponseSingle":{"properties":{"chart_id":{"description":"The ID of the chart the status belongs to","type":"integer"},"viz_error":{"description":"Error that occurred when warming cache for chart","type":"string"},"viz_status":{"description":"Status of the underlying query for the viz","type":"string"}},"type":"object"},"ChartDataAdhocMetricSchema":{"properties":{"aggregate":{"description":"Aggregation operator.Only required for simple expression types.","enum":["AVG","COUNT","COUNT_DISTINCT","MAX","MIN","SUM"],"type":"string"},"column":{"$ref":"#/components/schemas/ChartDataColumn"},"expressionType":{"description":"Simple or SQL metric","enum":["SIMPLE","SQL"],"example":"SQL","type":"string"},"hasCustomLabel":{"description":"When false, the label will be automatically generated based on the aggregate expression. When true, a custom label has to be specified.","example":true,"type":"boolean"},"isExtra":{"description":"Indicates if the filter has been added by a filter component as opposed to being a part of the original query.","type":"boolean"},"label":{"description":"Label for the metric. Is automatically generated unlesshasCustomLabel is true, in which case label must be defined.","example":"Weighted observations","type":"string"},"optionName":{"description":"Unique identifier. Can be any string value, as long as all metrics have a unique identifier. If undefined, a random namewill be generated.","example":"metric_aec60732-fac0-4b17-b736-93f1a5c93e30","type":"string"},"sqlExpression":{"description":"The metric as defined by a SQL aggregate expression. Only required for SQL expression type.","example":"SUM(weight * observations) / SUM(weight)","type":"string"},"timeGrain":{"description":"Optional time grain for temporal filters","example":"PT1M","type":"string"}},"required":["expressionType"],"type":"object"},"ChartDataAggregateOptionsSchema":{"properties":{"aggregates":{"description":"The keys are the name of the aggregate column to be created, and the values specify the details of how to apply the aggregation. If an operator requires additional options, these can be passed here to be unpacked in the operator call. The following numpy operators are supported: average, argmin, argmax, cumsum, cumprod, max, mean, median, nansum, nanmin, nanmax, nanmean, nanmedian, min, percentile, prod, product, std, sum, var. Any options required by the operator can be passed to the `options` object.\\n\\nIn the example, a new column `first_quantile` is created based on values in the column `my_col` using the `percentile` operator with the `q=0.25` parameter.","example":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"type":"object"}},"type":"object"},"ChartDataAsyncResponseSchema":{"properties":{"channel_id":{"description":"Unique session async channel ID","type":"string"},"job_id":{"description":"Unique async job ID","type":"string"},"result_url":{"description":"Unique result URL for fetching async query data","type":"string"},"status":{"description":"Status value for async job","type":"string"},"user_id":{"description":"Requesting user ID","nullable":true,"type":"string"}},"type":"object"},"ChartDataBoxplotOptionsSchema":{"properties":{"groupby":{"items":{"description":"Columns by which to group the query.","type":"string"},"nullable":true,"type":"array"},"metrics":{"description":"Aggregate expressions. Metrics can be passed as both references to datasource metrics (strings), or ad-hoc metricswhich are defined only within the query object. See `ChartDataAdhocMetricSchema` for the structure of ad-hoc metrics. When metrics is undefined or null, the query is executed without a groupby. However, when metrics is an array (length >= 0), a groupby clause is added to the query.","items":{},"nullable":true,"type":"array"},"percentiles":{"description":"Upper and lower percentiles for percentile whisker type.","example":[1,99]},"whisker_type":{"description":"Whisker type. Any numpy function will work.","enum":["tukey","min/max","percentile"],"example":"tukey","type":"string"}},"required":["whisker_type"],"type":"object"},"ChartDataColumn":{"properties":{"column_name":{"description":"The name of the target column","example":"mycol","type":"string"},"type":{"description":"Type of target column","example":"BIGINT","type":"string"}},"type":"object"},"ChartDataContributionOptionsSchema":{"properties":{"orientation":{"description":"Should cell values be calculated across the row or column.","enum":["row","column"],"example":"row","type":"string"}},"required":["orientation"],"type":"object"},"ChartDataDatasource":{"properties":{"id":{"description":"Datasource id","type":"integer"},"type":{"description":"Datasource type","enum":["sl_table","table","dataset","query","saved_query","view"],"type":"string"}},"required":["id"],"type":"object"},"ChartDataExtras":{"properties":{"having":{"description":"HAVING clause to be added to aggregate queries using AND operator.","type":"string"},"relative_end":{"description":"End time for relative time deltas. Default: `config[\\"DEFAULT_RELATIVE_START_TIME\\"]`","enum":["today","now"],"type":"string"},"relative_start":{"description":"Start time for relative time deltas. Default: `config[\\"DEFAULT_RELATIVE_START_TIME\\"]`","enum":["today","now"],"type":"string"},"time_grain_sqla":{"description":"To what level of granularity should the temporal column be aggregated. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.","enum":["PT1S","PT5S","PT30S","PT1M","PT5M","PT10M","PT15M","PT30M","PT1H","PT6H","P1D","P1W","P1M","P3M","P1Y","1969-12-28T00:00:00Z/P1W","1969-12-29T00:00:00Z/P1W","P1W/1970-01-03T00:00:00Z","P1W/1970-01-04T00:00:00Z","PT2H","PT4H","PT8H","PT10H","PT12H"],"example":"P1D","nullable":true,"type":"string"},"where":{"description":"WHERE clause to be added to queries using AND operator.","type":"string"}},"type":"object"},"ChartDataFilter":{"properties":{"col":{"description":"The column to filter by. Can be either a string (physical or saved expression) or an object (adhoc column)","example":"country"},"grain":{"description":"Optional time grain for temporal filters","example":"PT1M","type":"string"},"isExtra":{"description":"Indicates if the filter has been added by a filter component as opposed to being a part of the original query.","type":"boolean"},"op":{"description":"The comparison operator.","enum":["==","!=",">","<",">=","<=","LIKE","ILIKE","IS NULL","IS NOT NULL","IN","NOT IN","IS TRUE","IS FALSE","TEMPORAL_RANGE"],"example":"IN","type":"string"},"val":{"description":"The value or values to compare against. Can be a string, integer, decimal, None or list, depending on the operator.","example":["China","France","Japan"],"nullable":true}},"required":["col","op"],"type":"object"},"ChartDataGeodeticParseOptionsSchema":{"properties":{"altitude":{"description":"Name of target column for decoded altitude. If omitted, altitude information in geodetic string is ignored.","type":"string"},"geodetic":{"description":"Name of source column containing geodetic point strings","type":"string"},"latitude":{"description":"Name of target column for decoded latitude","type":"string"},"longitude":{"description":"Name of target column for decoded longitude","type":"string"}},"required":["geodetic","latitude","longitude"],"type":"object"},"ChartDataGeohashDecodeOptionsSchema":{"properties":{"geohash":{"description":"Name of source column containing geohash string","type":"string"},"latitude":{"description":"Name of target column for decoded latitude","type":"string"},"longitude":{"description":"Name of target column for decoded longitude","type":"string"}},"required":["geohash","latitude","longitude"],"type":"object"},"ChartDataGeohashEncodeOptionsSchema":{"properties":{"geohash":{"description":"Name of target column for encoded geohash string","type":"string"},"latitude":{"description":"Name of source latitude column","type":"string"},"longitude":{"description":"Name of source longitude column","type":"string"}},"required":["geohash","latitude","longitude"],"type":"object"},"ChartDataPivotOptionsSchema":{"properties":{"aggregates":{"description":"The keys are the name of the aggregate column to be created, and the values specify the details of how to apply the aggregation. If an operator requires additional options, these can be passed here to be unpacked in the operator call. The following numpy operators are supported: average, argmin, argmax, cumsum, cumprod, max, mean, median, nansum, nanmin, nanmax, nanmean, nanmedian, min, percentile, prod, product, std, sum, var. Any options required by the operator can be passed to the `options` object.\\n\\nIn the example, a new column `first_quantile` is created based on values in the column `my_col` using the `percentile` operator with the `q=0.25` parameter.","example":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"type":"object"},"column_fill_value":{"description":"Value to replace missing pivot columns names with.","type":"string"},"columns":{"description":"Columns to group by on the table columns","items":{"type":"string"},"type":"array"},"drop_missing_columns":{"description":"Do not include columns whose entries are all missing (default: `true`).","type":"boolean"},"marginal_distribution_name":{"description":"Name of marginal distribution row/column. (default: `All`)","type":"string"},"marginal_distributions":{"description":"Add totals for row/column. (default: `false`)","type":"boolean"},"metric_fill_value":{"description":"Value to replace missing values with in aggregate calculations.","type":"number"}},"type":"object"},"ChartDataPostProcessingOperation":{"properties":{"operation":{"description":"Post processing operation type","enum":["aggregate","boxplot","compare","contribution","cum","diff","escape_separator","flatten","geodetic_parse","geohash_decode","geohash_encode","pivot","prophet","rename","resample","rolling","select","sort","unescape_separator"],"example":"aggregate","type":"string"},"options":{"description":"Options specifying how to perform the operation. Please refer to the respective post processing operation option schemas. For example, `ChartDataPostProcessingOperationOptions` specifies the required options for the pivot operation.","example":{"aggregates":{"age_mean":{"column":"age","operator":"mean"},"age_q1":{"column":"age","operator":"percentile","options":{"q":0.25}}},"groupby":["country","gender"]},"type":"object"}},"required":["operation"],"type":"object"},"ChartDataProphetOptionsSchema":{"properties":{"confidence_interval":{"description":"Width of predicted confidence interval","example":0.8,"maximum":1,"minimum":0,"type":"number"},"monthly_seasonality":{"description":"Should monthly seasonality be applied. An integer value will specify Fourier order of seasonality, `None` will automatically detect seasonality.","example":false},"periods":{"description":"Time periods (in units of `time_grain`) to predict into the future","example":7,"type":"integer"},"time_grain":{"description":"Time grain used to specify time period increments in prediction. Supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) durations.","enum":["PT1S","PT5S","PT30S","PT1M","PT5M","PT10M","PT15M","PT30M","PT1H","PT6H","P1D","P1W","P1M","P3M","P1Y","1969-12-28T00:00:00Z/P1W","1969-12-29T00:00:00Z/P1W","P1W/1970-01-03T00:00:00Z","P1W/1970-01-04T00:00:00Z","PT2H","PT4H","PT8H","PT10H","PT12H"],"example":"P1D","type":"string"},"weekly_seasonality":{"description":"Should weekly seasonality be applied. An integer value will specify Fourier order of seasonality, `None` will automatically detect seasonality.","example":false},"yearly_seasonality":{"description":"Should yearly seasonality be applied. An integer value will specify Fourier order of seasonality, `None` will automatically detect seasonality.","example":false}},"required":["confidence_interval","periods","time_grain"],"type":"object"},"ChartDataQueryContextSchema":{"properties":{"custom_cache_timeout":{"description":"Override the default cache timeout","nullable":true,"type":"integer"},"datasource":{"$ref":"#/components/schemas/ChartDataDatasource"},"force":{"description":"Should the queries be forced to load from the source. Default: `false`","nullable":true,"type":"boolean"},"form_data":{"nullable":true},"queries":{"items":{"$ref":"#/components/schemas/ChartDataQueryObject"},"type":"array"},"result_format":{"enum":["csv","json","xlsx"]},"result_type":{"enum":["columns","full","query","results","samples","timegrains","post_processed","drill_detail"]}},"type":"object"},"ChartDataQueryObject":{"properties":{"annotation_layers":{"description":"Annotation layers to apply to chart","items":{"$ref":"#/components/schemas/AnnotationLayer"},"nullable":true,"type":"array"},"applied_time_extras":{"description":"A mapping of temporal extras that have been applied to the query","example":{"__time_range":"1 year ago : now"},"nullable":true,"type":"object"},"apply_fetch_values_predicate":{"description":"Add fetch values predicate (where clause) to query if defined in datasource","nullable":true,"type":"boolean"},"columns":{"description":"Columns which to select in the query.","items":{},"nullable":true,"type":"array"},"datasource":{"allOf":[{"$ref":"#/components/schemas/ChartDataDatasource"}],"nullable":true},"extras":{"allOf":[{"$ref":"#/components/schemas/ChartDataExtras"}],"description":"Extra parameters to add to the query.","nullable":true},"filters":{"items":{"$ref":"#/components/schemas/ChartDataFilter"},"nullable":true,"type":"array"},"granularity":{"description":"Name of temporal column used for time filtering. ","nullable":true,"type":"string"},"granularity_sqla":{"deprecated":true,"description":"Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use `granularity` instead.","nullable":true,"type":"string"},"groupby":{"description":"Columns by which to group the query. This field is deprecated, use `columns` instead.","items":{},"nullable":true,"type":"array"},"having":{"deprecated":true,"description":"HAVING clause to be added to aggregate queries using AND operator. This field is deprecated and should be passed to `extras`.","nullable":true,"type":"string"},"is_rowcount":{"description":"Should the rowcount of the actual query be returned","nullable":true,"type":"boolean"},"is_timeseries":{"description":"Is the `query_object` a timeseries.","nullable":true,"type":"boolean"},"metrics":{"description":"Aggregate expressions. Metrics can be passed as both references to datasource metrics (strings), or ad-hoc metricswhich are defined only within the query object. See `ChartDataAdhocMetricSchema` for the structure of ad-hoc metrics.","items":{},"nullable":true,"type":"array"},"order_desc":{"description":"Reverse order. Default: `false`","nullable":true,"type":"boolean"},"orderby":{"description":"Expects a list of lists where the first element is the column name which to sort by, and the second element is a boolean.","example":[["my_col_1",false],["my_col_2",true]],"items":{},"nullable":true,"type":"array"},"post_processing":{"description":"Post processing operations to be applied to the result set. Operations are applied to the result set in sequential order.","items":{"allOf":[{"$ref":"#/components/schemas/ChartDataPostProcessingOperation"}],"nullable":true},"nullable":true,"type":"array"},"result_type":{"enum":["columns","full","query","results","samples","timegrains","post_processed","drill_detail"],"nullable":true},"row_limit":{"description":"Maximum row count (0=disabled). Default: `config[\\"ROW_LIMIT\\"]`","minimum":0,"nullable":true,"type":"integer"},"row_offset":{"description":"Number of rows to skip. Default: `0`","minimum":0,"nullable":true,"type":"integer"},"series_columns":{"description":"Columns to use when limiting series count. All columns must be present in the `columns` property. Requires `series_limit` and `series_limit_metric` to be set.","items":{},"nullable":true,"type":"array"},"series_limit":{"description":"Maximum number of series. Requires `series` and `series_limit_metric` to be set.","nullable":true,"type":"integer"},"series_limit_metric":{"description":"Metric used to limit timeseries queries by. Requires `series` and `series_limit` to be set.","nullable":true},"time_offsets":{"items":{"type":"string"},"nullable":true,"type":"array"},"time_range":{"description":"A time rage, either expressed as a colon separated string `since : until` or human readable freeform. Valid formats for `since` and `until` are: \\n- ISO 8601\\n- X days/years/hours/day/year/weeks\\n- X days/years/hours/day/year/weeks ago\\n- X days/years/hours/day/year/weeks from now\\n\\nAdditionally, the following freeform can be used:\\n\\n- Last day\\n- Last week\\n- Last month\\n- Last quarter\\n- Last year\\n- No filter\\n- Last X seconds/minutes/hours/days/weeks/months/years\\n- Next X seconds/minutes/hours/days/weeks/months/years\\n","example":"Last week","nullable":true,"type":"string"},"time_shift":{"description":"A human-readable date/time string. Please refer to [parsdatetime](https://github.com/bear/parsedatetime) documentation for details on valid values.","nullable":true,"type":"string"},"timeseries_limit":{"description":"Maximum row count for timeseries queries. This field is deprecated, use `series_limit` instead.Default: `0`","nullable":true,"type":"integer"},"timeseries_limit_metric":{"description":"Metric used to limit timeseries queries by. This field is deprecated, use `series_limit_metric` instead.","nullable":true},"url_params":{"additionalProperties":{"description":"The value of the query parameter","type":"string"},"description":"Optional query parameters passed to a dashboard or Explore view","nullable":true,"type":"object"},"where":{"deprecated":true,"description":"WHERE clause to be added to queries using AND operator.This field is deprecated and should be passed to `extras`.","nullable":true,"type":"string"}},"type":"object"},"ChartDataResponseResult":{"properties":{"annotation_data":{"description":"All requested annotation data","items":{"additionalProperties":{"type":"string"},"type":"object"},"nullable":true,"type":"array"},"applied_filters":{"description":"A list with applied filters","items":{"type":"object"},"type":"array"},"cache_key":{"description":"Unique cache key for query object","nullable":true,"type":"string"},"cache_timeout":{"description":"Cache timeout in following order: custom timeout, datasource timeout, cache default timeout, config default cache timeout.","nullable":true,"type":"integer"},"cached_dttm":{"description":"Cache timestamp","nullable":true,"type":"string"},"colnames":{"description":"A list of column names","items":{"type":"string"},"type":"array"},"coltypes":{"description":"A list of generic data types of each column","items":{"type":"integer"},"type":"array"},"data":{"description":"A list with results","items":{"type":"object"},"type":"array"},"error":{"description":"Error","nullable":true,"type":"string"},"from_dttm":{"description":"Start timestamp of time range","nullable":true,"type":"integer"},"is_cached":{"description":"Is the result cached","type":"boolean"},"query":{"description":"The executed query statement","type":"string"},"rejected_filters":{"description":"A list with rejected filters","items":{"type":"object"},"type":"array"},"rowcount":{"description":"Amount of rows in result set","type":"integer"},"stacktrace":{"description":"Stacktrace if there was an error","nullable":true,"type":"string"},"status":{"description":"Status of the query","enum":["stopped","failed","pending","running","scheduled","success","timed_out"],"type":"string"},"to_dttm":{"description":"End timestamp of time range","nullable":true,"type":"integer"}},"required":["cache_key","cache_timeout","cached_dttm","is_cached","query"],"type":"object"},"ChartDataResponseSchema":{"properties":{"result":{"description":"A list of results for each corresponding query in the request.","items":{"$ref":"#/components/schemas/ChartDataResponseResult"},"type":"array"}},"type":"object"},"ChartDataRestApi.get":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"dashboards":{"$ref":"#/components/schemas/ChartDataRestApi.get.Dashboard"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"owners":{"$ref":"#/components/schemas/ChartDataRestApi.get.User"},"params":{"nullable":true,"type":"string"},"query_context":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"tags":{"$ref":"#/components/schemas/ChartDataRestApi.get.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"ChartDataRestApi.get.Dashboard":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"}},"type":"object"},"ChartDataRestApi.get.Tag":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"ChartDataRestApi.get.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartDataRestApi.get_list":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_by":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.User3"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_dttm":{"readOnly":true},"changed_on_utc":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.User"},"created_by_name":{"readOnly":true},"created_on_delta_humanized":{"readOnly":true},"dashboards":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.Dashboard"},"datasource_id":{"nullable":true,"type":"integer"},"datasource_name_text":{"readOnly":true},"datasource_type":{"maxLength":200,"nullable":true,"type":"string"},"datasource_url":{"readOnly":true},"description":{"nullable":true,"type":"string"},"description_markeddown":{"readOnly":true},"edit_url":{"readOnly":true},"form_data":{"readOnly":true},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"last_saved_at":{"format":"date-time","nullable":true,"type":"string"},"last_saved_by":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.User2"},"owners":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.User1"},"params":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"slice_url":{"readOnly":true},"table":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.SqlaTable"},"tags":{"$ref":"#/components/schemas/ChartDataRestApi.get_list.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"ChartDataRestApi.get_list.Dashboard":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object"},"ChartDataRestApi.get_list.SqlaTable":{"properties":{"default_endpoint":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"}},"required":["table_name"],"type":"object"},"ChartDataRestApi.get_list.Tag":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"ChartDataRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartDataRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartDataRestApi.get_list.User2":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartDataRestApi.get_list.User3":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartDataRestApi.post":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasouce_id` and `datasource_type`.","type":"integer"},"datasource_name":{"description":"The datasource name.","nullable":true,"type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["sl_table","table","dataset","query","saved_query","view"],"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"type":"string"},"query_context_generation":{"description":"The query context generation represents whether the query_contextis user generated or not so that it does not update user modfiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":1,"type":"string"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"type":"string"}},"required":["datasource_id","datasource_type","slice_name"],"type":"object"},"ChartDataRestApi.put":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasouce_id` and `datasource_type`.","nullable":true,"type":"integer"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["sl_table","table","dataset","query","saved_query","view"],"nullable":true,"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"type":"string"},"query_context_generation":{"description":"The query context generation represents whether the query_contextis user generated or not so that it does not update user modfiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"ChartDataRollingOptionsSchema":{"properties":{"center":{"description":"Should the label be at the center of the window.Default: `false`","example":false,"type":"boolean"},"min_periods":{"description":"The minimum amount of periods required for a row to be included in the result set.","example":7,"type":"integer"},"rolling_type":{"description":"Type of rolling window. Any numpy function will work.","enum":["average","argmin","argmax","cumsum","cumprod","max","mean","median","nansum","nanmin","nanmax","nanmean","nanmedian","nanpercentile","min","percentile","prod","product","std","sum","var"],"example":"percentile","type":"string"},"rolling_type_options":{"description":"Optional options to pass to rolling method. Needed for e.g. quantile operation.","example":{},"type":"object"},"win_type":{"description":"Type of window function. See [SciPy window functions](https://docs.scipy.org/doc/scipy/reference /signal.windows.html#module-scipy.signal.windows) for more details. Some window functions require passing additional parameters to `rolling_type_options`. For instance, to use `gaussian`, the parameter `std` needs to be provided.","enum":["boxcar","triang","blackman","hamming","bartlett","parzen","bohman","blackmanharris","nuttall","barthann","kaiser","gaussian","general_gaussian","slepian","exponential"],"type":"string"},"window":{"description":"Size of the rolling window in days.","example":7,"type":"integer"}},"required":["rolling_type","window"],"type":"object"},"ChartDataSelectOptionsSchema":{"properties":{"columns":{"description":"Columns which to select from the input data, in the desired order. If columns are renamed, the original column name should be referenced here.","example":["country","gender","age"],"items":{"type":"string"},"type":"array"},"exclude":{"description":"Columns to exclude from selection.","example":["my_temp_column"],"items":{"type":"string"},"type":"array"},"rename":{"description":"columns which to rename, mapping source column to target column. For instance, `{\'y\': \'y2\'}` will rename the column `y` to `y2`.","example":[{"age":"average_age"}],"items":{"type":"object"},"type":"array"}},"type":"object"},"ChartDataSortOptionsSchema":{"properties":{"aggregates":{"description":"The keys are the name of the aggregate column to be created, and the values specify the details of how to apply the aggregation. If an operator requires additional options, these can be passed here to be unpacked in the operator call. The following numpy operators are supported: average, argmin, argmax, cumsum, cumprod, max, mean, median, nansum, nanmin, nanmax, nanmean, nanmedian, min, percentile, prod, product, std, sum, var. Any options required by the operator can be passed to the `options` object.\\n\\nIn the example, a new column `first_quantile` is created based on values in the column `my_col` using the `percentile` operator with the `q=0.25` parameter.","example":{"first_quantile":{"column":"my_col","operator":"percentile","options":{"q":0.25}}},"type":"object"},"columns":{"description":"columns by by which to sort. The key specifies the column name, value specifies if sorting in ascending order.","example":{"country":true,"gender":false},"type":"object"}},"required":["columns"],"type":"object"},"ChartEntityResponseSchema":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","type":"integer"},"certification_details":{"description":"Details of the certification","type":"string"},"certified_by":{"description":"Person or group that has certified this chart","type":"string"},"changed_on":{"description":"The ISO date that the chart was last changed.","format":"date-time","type":"string"},"description":{"description":"A description of the chart propose.","type":"string"},"description_markeddown":{"description":"Sanitized HTML version of the chart description.","type":"string"},"form_data":{"description":"Form data from the Explore controls used to form the chart\'s data query.","type":"object"},"id":{"description":"The id of the chart.","type":"integer"},"slice_name":{"description":"The name of the chart.","type":"string"},"slice_url":{"description":"The URL of the chart.","type":"string"}},"type":"object"},"ChartFavStarResponseResult":{"properties":{"id":{"description":"The Chart id","type":"integer"},"value":{"description":"The FaveStar value","type":"boolean"}},"type":"object"},"ChartGetDatasourceObjectDataResponse":{"properties":{"datasource_id":{"description":"The datasource identifier","type":"integer"},"datasource_type":{"description":"The datasource type","type":"integer"}},"type":"object"},"ChartGetDatasourceObjectResponse":{"properties":{"label":{"description":"The name of the datasource","type":"string"},"value":{"$ref":"#/components/schemas/ChartGetDatasourceObjectDataResponse"}},"type":"object"},"ChartGetDatasourceResponseSchema":{"properties":{"count":{"description":"The total number of datasources","type":"integer"},"result":{"$ref":"#/components/schemas/ChartGetDatasourceObjectResponse"}},"type":"object"},"ChartRestApi.get":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"dashboards":{"$ref":"#/components/schemas/ChartRestApi.get.Dashboard"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"owners":{"$ref":"#/components/schemas/ChartRestApi.get.User"},"params":{"nullable":true,"type":"string"},"query_context":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"tags":{"$ref":"#/components/schemas/ChartRestApi.get.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"ChartRestApi.get.Dashboard":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"json_metadata":{"nullable":true,"type":"string"}},"type":"object"},"ChartRestApi.get.Tag":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"ChartRestApi.get.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartRestApi.get_list":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_by":{"$ref":"#/components/schemas/ChartRestApi.get_list.User3"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_dttm":{"readOnly":true},"changed_on_utc":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/ChartRestApi.get_list.User"},"created_by_name":{"readOnly":true},"created_on_delta_humanized":{"readOnly":true},"dashboards":{"$ref":"#/components/schemas/ChartRestApi.get_list.Dashboard"},"datasource_id":{"nullable":true,"type":"integer"},"datasource_name_text":{"readOnly":true},"datasource_type":{"maxLength":200,"nullable":true,"type":"string"},"datasource_url":{"readOnly":true},"description":{"nullable":true,"type":"string"},"description_markeddown":{"readOnly":true},"edit_url":{"readOnly":true},"form_data":{"readOnly":true},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"last_saved_at":{"format":"date-time","nullable":true,"type":"string"},"last_saved_by":{"$ref":"#/components/schemas/ChartRestApi.get_list.User2"},"owners":{"$ref":"#/components/schemas/ChartRestApi.get_list.User1"},"params":{"nullable":true,"type":"string"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"slice_url":{"readOnly":true},"table":{"$ref":"#/components/schemas/ChartRestApi.get_list.SqlaTable"},"tags":{"$ref":"#/components/schemas/ChartRestApi.get_list.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"ChartRestApi.get_list.Dashboard":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object"},"ChartRestApi.get_list.SqlaTable":{"properties":{"default_endpoint":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"}},"required":["table_name"],"type":"object"},"ChartRestApi.get_list.Tag":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"ChartRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartRestApi.get_list.User2":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartRestApi.get_list.User3":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ChartRestApi.post":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasouce_id` and `datasource_type`.","type":"integer"},"datasource_name":{"description":"The datasource name.","nullable":true,"type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["sl_table","table","dataset","query","saved_query","view"],"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"type":"string"},"query_context_generation":{"description":"The query context generation represents whether the query_contextis user generated or not so that it does not update user modfiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":1,"type":"string"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"type":"string"}},"required":["datasource_id","datasource_type","slice_name"],"type":"object"},"ChartRestApi.put":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart. Note this defaults to the datasource/table timeout if undefined.","nullable":true,"type":"integer"},"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this chart","nullable":true,"type":"string"},"dashboards":{"items":{"description":"A list of dashboards to include this new chart to.","type":"integer"},"type":"array"},"datasource_id":{"description":"The id of the dataset/datasource this new chart will use. A complete datasource identification needs `datasouce_id` and `datasource_type`.","nullable":true,"type":"integer"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["sl_table","table","dataset","query","saved_query","view"],"nullable":true,"type":"string"},"description":{"description":"A description of the chart propose.","nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this chart. If left empty you will be one of the owners of the chart.","type":"integer"},"type":"array"},"params":{"description":"Parameters are generated dynamically when clicking the save or overwrite button in the explore view. This JSON object for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"query_context":{"description":"The query context represents the queries that need to run in order to generate the data the visualization, and in what format the data should be returned.","nullable":true,"type":"string"},"query_context_generation":{"description":"The query context generation represents whether the query_contextis user generated or not so that it does not update user modfiedstate.","nullable":true,"type":"boolean"},"slice_name":{"description":"The name of the chart.","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"viz_type":{"description":"The type of chart visualization used.","example":["bar","area","table"],"maxLength":250,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"CssTemplateRestApi.get":{"properties":{"created_by":{"$ref":"#/components/schemas/CssTemplateRestApi.get.User"},"css":{"nullable":true,"type":"string"},"id":{"type":"integer"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"CssTemplateRestApi.get.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"CssTemplateRestApi.get_list":{"properties":{"changed_by":{"$ref":"#/components/schemas/CssTemplateRestApi.get_list.User1"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/CssTemplateRestApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"css":{"nullable":true,"type":"string"},"id":{"type":"integer"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"CssTemplateRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"CssTemplateRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"CssTemplateRestApi.post":{"properties":{"css":{"nullable":true,"type":"string"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"CssTemplateRestApi.put":{"properties":{"css":{"nullable":true,"type":"string"},"template_name":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"DashboardCopySchema":{"properties":{"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","maxLength":500,"minLength":0,"nullable":true,"type":"string"},"duplicate_slices":{"description":"Whether or not to also copy all charts on the dashboard","type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","type":"string"}},"required":["json_metadata"],"type":"object"},"DashboardDatasetSchema":{"properties":{"cache_timeout":{"type":"integer"},"column_formats":{"type":"object"},"column_types":{"items":{"type":"integer"},"type":"array"},"columns":{"items":{"type":"object"},"type":"array"},"currency_formats":{"type":"object"},"database":{"$ref":"#/components/schemas/Database"},"datasource_name":{"type":"string"},"default_endpoint":{"type":"string"},"edit_url":{"type":"string"},"fetch_values_predicate":{"type":"string"},"filter_select":{"type":"boolean"},"filter_select_enabled":{"type":"boolean"},"granularity_sqla":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"health_check_message":{"type":"string"},"id":{"type":"integer"},"is_sqllab_view":{"type":"boolean"},"main_dttm_col":{"type":"string"},"metrics":{"items":{"type":"object"},"type":"array"},"name":{"type":"string"},"offset":{"type":"integer"},"order_by_choices":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"owners":{"items":{"type":"object"},"type":"array"},"params":{"type":"string"},"perm":{"type":"string"},"schema":{"type":"string"},"select_star":{"type":"string"},"sql":{"type":"string"},"table_name":{"type":"string"},"template_params":{"type":"string"},"time_grain_sqla":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"},"type":{"type":"string"},"uid":{"type":"string"},"verbose_map":{"additionalProperties":{"type":"string"},"type":"object"}},"type":"object"},"DashboardGetResponseSchema":{"properties":{"certification_details":{"description":"Details of the certification","type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard","type":"string"},"changed_by":{"$ref":"#/components/schemas/User"},"changed_by_name":{"type":"string"},"changed_on":{"format":"date-time","type":"string"},"changed_on_delta_humanized":{"type":"string"},"charts":{"items":{"description":"The names of the dashboard\'s charts. Names are used for legacy reasons.","type":"string"},"type":"array"},"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","type":"string"},"id":{"type":"integer"},"is_managed_externally":{"nullable":true,"type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","type":"string"},"owners":{"items":{"$ref":"#/components/schemas/User"},"type":"array"},"position_json":{"description":"This json object describes the positioning of the widgets in the dashboard. It is dynamically generated when adjusting the widgets size and positions by using drag & drop in the dashboard view","type":"string"},"published":{"type":"boolean"},"roles":{"items":{"$ref":"#/components/schemas/Roles"},"type":"array"},"slug":{"type":"string"},"tags":{"items":{"$ref":"#/components/schemas/Tag1"},"type":"array"},"thumbnail_url":{"type":"string"},"url":{"type":"string"}},"type":"object"},"DashboardPermalinkStateSchema":{"properties":{"activeTabs":{"description":"Current active dashboard tabs","items":{"type":"string"},"nullable":true,"type":"array"},"anchor":{"description":"Optional anchor link added to url hash","nullable":true,"type":"string"},"dataMask":{"description":"Data mask used for native filter state","nullable":true,"type":"object"},"urlParams":{"description":"URL Parameters","items":{"description":"URL Parameter key-value pair","nullable":true},"nullable":true,"type":"array"}},"type":"object"},"DashboardRestApi.get":{"properties":{"id":{"type":"integer"}},"type":"object"},"DashboardRestApi.get_list":{"properties":{"certification_details":{"nullable":true,"type":"string"},"certified_by":{"nullable":true,"type":"string"},"changed_by":{"$ref":"#/components/schemas/DashboardRestApi.get_list.User2"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_utc":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/DashboardRestApi.get_list.User"},"created_on_delta_humanized":{"readOnly":true},"css":{"nullable":true,"type":"string"},"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"json_metadata":{"nullable":true,"type":"string"},"owners":{"$ref":"#/components/schemas/DashboardRestApi.get_list.User1"},"position_json":{"nullable":true,"type":"string"},"published":{"nullable":true,"type":"boolean"},"roles":{"$ref":"#/components/schemas/DashboardRestApi.get_list.Role"},"slug":{"maxLength":255,"nullable":true,"type":"string"},"status":{"readOnly":true},"tags":{"$ref":"#/components/schemas/DashboardRestApi.get_list.Tag"},"thumbnail_url":{"readOnly":true},"url":{"readOnly":true}},"type":"object"},"DashboardRestApi.get_list.Role":{"properties":{"id":{"type":"integer"},"name":{"maxLength":64,"type":"string"}},"required":["name"],"type":"object"},"DashboardRestApi.get_list.Tag":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"DashboardRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DashboardRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DashboardRestApi.get_list.User2":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DashboardRestApi.post":{"properties":{"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard","nullable":true,"type":"string"},"css":{"description":"Override CSS for the dashboard.","type":"string"},"dashboard_title":{"description":"A title for the dashboard.","maxLength":500,"minLength":0,"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this dashboard. If left empty you will be one of the owners of the dashboard.","type":"integer"},"type":"array"},"position_json":{"description":"This json object describes the positioning of the widgets in the dashboard. It is dynamically generated when adjusting the widgets size and positions by using drag & drop in the dashboard view","type":"string"},"published":{"description":"Determines whether or not this dashboard is visible in the list of all dashboards.","type":"boolean"},"roles":{"items":{"description":"Roles is a list which defines access to the dashboard. These roles are always applied in addition to restrictions on dataset level access. If no roles defined then the dashboard is available to all roles.","type":"integer"},"type":"array"},"slug":{"description":"Unique identifying part for the web address of the dashboard.","maxLength":255,"minLength":1,"nullable":true,"type":"string"}},"type":"object"},"DashboardRestApi.put":{"properties":{"certification_details":{"description":"Details of the certification","nullable":true,"type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard","nullable":true,"type":"string"},"css":{"description":"Override CSS for the dashboard.","nullable":true,"type":"string"},"dashboard_title":{"description":"A title for the dashboard.","maxLength":500,"minLength":0,"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"json_metadata":{"description":"This JSON object is generated dynamically when clicking the save or overwrite button in the dashboard view. It is exposed here for reference and for power users who may want to alter specific parameters.","nullable":true,"type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this dashboard. If left empty you will be one of the owners of the dashboard.","nullable":true,"type":"integer"},"type":"array"},"position_json":{"description":"This json object describes the positioning of the widgets in the dashboard. It is dynamically generated when adjusting the widgets size and positions by using drag & drop in the dashboard view","nullable":true,"type":"string"},"published":{"description":"Determines whether or not this dashboard is visible in the list of all dashboards.","nullable":true,"type":"boolean"},"roles":{"items":{"description":"Roles is a list which defines access to the dashboard. These roles are always applied in addition to restrictions on dataset level access. If no roles defined then the dashboard is available to all roles.","nullable":true,"type":"integer"},"type":"array"},"slug":{"description":"Unique identifying part for the web address of the dashboard.","maxLength":255,"minLength":0,"nullable":true,"type":"string"}},"type":"object"},"Database":{"properties":{"allows_cost_estimate":{"type":"boolean"},"allows_subquery":{"type":"boolean"},"allows_virtual_table_explore":{"type":"boolean"},"backend":{"type":"string"},"disable_data_preview":{"type":"boolean"},"explore_database_id":{"type":"integer"},"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"Database1":{"properties":{"database_name":{"type":"string"}},"type":"object"},"DatabaseConnectionSchema":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"backend":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","type":"string"},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine_information":{"additionalProperties":{},"type":"object"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"extra":{"description":"<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\\" rel=\\"noopener noreferrer\\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\\" rel=\\"noopener noreferrer\\">sqlalchemy.MetaData</a> call.<br>2. The <code>metadata_cache_timeout</code> is a cache timeout setting in seconds for metadata fetch of this database. Specify it as <strong>\\"metadata_cache_timeout\\": {\\"schema_cache_timeout\\": 600, \\"table_cache_timeout\\": 600}</strong>. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.<br>3. The <code>schemas_allowed_for_file_upload</code> is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as <strong>\\"schemas_allowed_for_file_upload\\": [\\"public\\", \\"csv_upload\\"]</strong>. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty<br>4. The <code>version</code> field is a string specifying the this db\'s version. This should be used with Presto DBs so that the syntax is correct<br>5. The <code>allows_virtual_table_explore</code> field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.<br>6. The <code>disable_data_preview</code> field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.</p>","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"id":{"description":"Database ID (for updates)","type":"integer"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.<br/>If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"<p>JSON string containing additional connection configuration.<br>This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.</p>","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"parameters_schema":{"additionalProperties":{},"description":"JSONSchema for configuring the database by parameters instead of SQLAlchemy URI","type":"object"},"server_cert":{"description":"<p>Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.</p>","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"<p>Refer to the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_2/core/engines.html#database-urls\\" rel=\\"noopener noreferrer\\">SqlAlchemy docs</a> for more information on how to structure your URI.</p>","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"$ref":"#/components/schemas/DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"type":"object"},"DatabaseFunctionNamesResponse":{"properties":{"function_names":{"items":{"type":"string"},"type":"array"}},"type":"object"},"DatabaseRelatedChart":{"properties":{"id":{"type":"integer"},"slice_name":{"type":"string"},"viz_type":{"type":"string"}},"type":"object"},"DatabaseRelatedCharts":{"properties":{"count":{"description":"Chart count","type":"integer"},"result":{"description":"A list of dashboards","items":{"$ref":"#/components/schemas/DatabaseRelatedChart"},"type":"array"}},"type":"object"},"DatabaseRelatedDashboard":{"properties":{"id":{"type":"integer"},"json_metadata":{"type":"object"},"slug":{"type":"string"},"title":{"type":"string"}},"type":"object"},"DatabaseRelatedDashboards":{"properties":{"count":{"description":"Dashboard count","type":"integer"},"result":{"description":"A list of dashboards","items":{"$ref":"#/components/schemas/DatabaseRelatedDashboard"},"type":"array"}},"type":"object"},"DatabaseRelatedObjectsResponse":{"properties":{"charts":{"$ref":"#/components/schemas/DatabaseRelatedCharts"},"dashboards":{"$ref":"#/components/schemas/DatabaseRelatedDashboards"}},"type":"object"},"DatabaseRestApi.get":{"properties":{"allow_ctas":{"nullable":true,"type":"boolean"},"allow_cvas":{"nullable":true,"type":"boolean"},"allow_dml":{"nullable":true,"type":"boolean"},"allow_file_upload":{"nullable":true,"type":"boolean"},"allow_run_async":{"nullable":true,"type":"boolean"},"backend":{"readOnly":true},"cache_timeout":{"nullable":true,"type":"integer"},"configuration_method":{"maxLength":255,"nullable":true,"type":"string"},"database_name":{"maxLength":250,"type":"string"},"driver":{"readOnly":true},"engine_information":{"readOnly":true},"expose_in_sqllab":{"nullable":true,"type":"boolean"},"force_ctas_schema":{"maxLength":250,"nullable":true,"type":"string"},"id":{"type":"integer"},"impersonate_user":{"nullable":true,"type":"boolean"},"is_managed_externally":{"type":"boolean"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["database_name"],"type":"object"},"DatabaseRestApi.get_list":{"properties":{"allow_ctas":{"nullable":true,"type":"boolean"},"allow_cvas":{"nullable":true,"type":"boolean"},"allow_dml":{"nullable":true,"type":"boolean"},"allow_file_upload":{"nullable":true,"type":"boolean"},"allow_run_async":{"nullable":true,"type":"boolean"},"allows_cost_estimate":{"readOnly":true},"allows_subquery":{"readOnly":true},"allows_virtual_table_explore":{"readOnly":true},"backend":{"readOnly":true},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/DatabaseRestApi.get_list.User"},"database_name":{"maxLength":250,"type":"string"},"disable_data_preview":{"readOnly":true},"engine_information":{"readOnly":true},"explore_database_id":{"readOnly":true},"expose_in_sqllab":{"nullable":true,"type":"boolean"},"extra":{"nullable":true,"type":"string"},"force_ctas_schema":{"maxLength":250,"nullable":true,"type":"string"},"id":{"type":"integer"},"uuid":{"format":"uuid","nullable":true,"type":"string"}},"required":["database_name"],"type":"object"},"DatabaseRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DatabaseRestApi.post":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"description":"<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\\" rel=\\"noopener noreferrer\\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\\" rel=\\"noopener noreferrer\\">sqlalchemy.MetaData</a> call.<br>2. The <code>metadata_cache_timeout</code> is a cache timeout setting in seconds for metadata fetch of this database. Specify it as <strong>\\"metadata_cache_timeout\\": {\\"schema_cache_timeout\\": 600, \\"table_cache_timeout\\": 600}</strong>. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.<br>3. The <code>schemas_allowed_for_file_upload</code> is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as <strong>\\"schemas_allowed_for_file_upload\\": [\\"public\\", \\"csv_upload\\"]</strong>. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty<br>4. The <code>version</code> field is a string specifying the this db\'s version. This should be used with Presto DBs so that the syntax is correct<br>5. The <code>allows_virtual_table_explore</code> field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.<br>6. The <code>disable_data_preview</code> field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.</p>","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.<br/>If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"<p>JSON string containing additional connection configuration.<br>This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.</p>","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"<p>Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.</p>","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"<p>Refer to the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_2/core/engines.html#database-urls\\" rel=\\"noopener noreferrer\\">SqlAlchemy docs</a> for more information on how to structure your URI.</p>","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"$ref":"#/components/schemas/DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"required":["database_name"],"type":"object"},"DatabaseRestApi.put":{"properties":{"allow_ctas":{"description":"Allow CREATE TABLE AS option in SQL Lab","type":"boolean"},"allow_cvas":{"description":"Allow CREATE VIEW AS option in SQL Lab","type":"boolean"},"allow_dml":{"description":"Allow users to run non-SELECT statements (UPDATE, DELETE, CREATE, ...) in SQL Lab","type":"boolean"},"allow_file_upload":{"description":"Allow to upload CSV file data into this databaseIf selected, please set the schemas allowed for csv upload in Extra.","type":"boolean"},"allow_run_async":{"description":"Operate the database in asynchronous mode, meaning that the queries are executed on remote workers as opposed to on the web server itself. This assumes that you have a Celery worker setup as well as a results backend. Refer to the installation docs for more information.","type":"boolean"},"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for charts of this database. A timeout of 0 indicates that the cache never expires. Note this defaults to the global timeout if undefined.","nullable":true,"type":"integer"},"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"expose_in_sqllab":{"description":"Expose this database to SQLLab","type":"boolean"},"external_url":{"nullable":true,"type":"string"},"extra":{"description":"<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\\" rel=\\"noopener noreferrer\\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\\" rel=\\"noopener noreferrer\\">sqlalchemy.MetaData</a> call.<br>2. The <code>metadata_cache_timeout</code> is a cache timeout setting in seconds for metadata fetch of this database. Specify it as <strong>\\"metadata_cache_timeout\\": {\\"schema_cache_timeout\\": 600, \\"table_cache_timeout\\": 600}</strong>. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.<br>3. The <code>schemas_allowed_for_file_upload</code> is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as <strong>\\"schemas_allowed_for_file_upload\\": [\\"public\\", \\"csv_upload\\"]</strong>. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty<br>4. The <code>version</code> field is a string specifying the this db\'s version. This should be used with Presto DBs so that the syntax is correct<br>5. The <code>allows_virtual_table_explore</code> field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.<br>6. The <code>disable_data_preview</code> field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.</p>","type":"string"},"force_ctas_schema":{"description":"When allowing CREATE TABLE AS option in SQL Lab, this option forces the table to be created in this schema","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.<br/>If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"masked_encrypted_extra":{"description":"<p>JSON string containing additional connection configuration.<br>This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.</p>","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"<p>Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.</p>","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"<p>Refer to the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_2/core/engines.html#database-urls\\" rel=\\"noopener noreferrer\\">SqlAlchemy docs</a> for more information on how to structure your URI.</p>","maxLength":1024,"minLength":0,"type":"string"},"ssh_tunnel":{"allOf":[{"$ref":"#/components/schemas/DatabaseSSHTunnel"}],"nullable":true},"uuid":{"type":"string"}},"type":"object"},"DatabaseSSHTunnel":{"properties":{"id":{"description":"SSH Tunnel ID (for updates)","nullable":true,"type":"integer"},"password":{"type":"string"},"private_key":{"type":"string"},"private_key_password":{"type":"string"},"server_address":{"type":"string"},"server_port":{"type":"integer"},"username":{"type":"string"}},"type":"object"},"DatabaseSchemaAccessForFileUploadResponse":{"properties":{"schemas":{"description":"The list of schemas allowed for the database to upload information","items":{"type":"string"},"type":"array"}},"type":"object"},"DatabaseTablesResponse":{"properties":{"extra":{"description":"Extra data used to specify column metadata","type":"object"},"type":{"description":"table or view","type":"string"},"value":{"description":"The table or view name","type":"string"}},"type":"object"},"DatabaseTestConnectionSchema":{"properties":{"configuration_method":{"default":"sqlalchemy_form","description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","nullable":true,"type":"string"},"extra":{"description":"<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\\" rel=\\"noopener noreferrer\\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\\" rel=\\"noopener noreferrer\\">sqlalchemy.MetaData</a> call.<br>2. The <code>metadata_cache_timeout</code> is a cache timeout setting in seconds for metadata fetch of this database. Specify it as <strong>\\"metadata_cache_timeout\\": {\\"schema_cache_timeout\\": 600, \\"table_cache_timeout\\": 600}</strong>. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.<br>3. The <code>schemas_allowed_for_file_upload</code> is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as <strong>\\"schemas_allowed_for_file_upload\\": [\\"public\\", \\"csv_upload\\"]</strong>. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty<br>4. The <code>version</code> field is a string specifying the this db\'s version. This should be used with Presto DBs so that the syntax is correct<br>5. The <code>allows_virtual_table_explore</code> field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.<br>6. The <code>disable_data_preview</code> field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.</p>","type":"string"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.<br/>If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"masked_encrypted_extra":{"description":"<p>JSON string containing additional connection configuration.<br>This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.</p>","nullable":true,"type":"string"},"parameters":{"additionalProperties":{},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"<p>Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.</p>","nullable":true,"type":"string"},"sqlalchemy_uri":{"description":"<p>Refer to the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_2/core/engines.html#database-urls\\" rel=\\"noopener noreferrer\\">SqlAlchemy docs</a> for more information on how to structure your URI.</p>","maxLength":1024,"minLength":1,"type":"string"},"ssh_tunnel":{"allOf":[{"$ref":"#/components/schemas/DatabaseSSHTunnel"}],"nullable":true}},"type":"object"},"DatabaseValidateParametersSchema":{"properties":{"catalog":{"additionalProperties":{"nullable":true},"description":"Gsheets specific column for managing label to sheet urls","type":"object"},"configuration_method":{"description":"Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.","enum":["sqlalchemy_form","dynamic_form"]},"database_name":{"description":"A database name to identify this connection.","maxLength":250,"minLength":1,"nullable":true,"type":"string"},"driver":{"description":"SQLAlchemy driver to use","nullable":true,"type":"string"},"engine":{"description":"SQLAlchemy engine to use","type":"string"},"extra":{"description":"<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\\" rel=\\"noopener noreferrer\\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\\" rel=\\"noopener noreferrer\\">sqlalchemy.MetaData</a> call.<br>2. The <code>metadata_cache_timeout</code> is a cache timeout setting in seconds for metadata fetch of this database. Specify it as <strong>\\"metadata_cache_timeout\\": {\\"schema_cache_timeout\\": 600, \\"table_cache_timeout\\": 600}</strong>. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.<br>3. The <code>schemas_allowed_for_file_upload</code> is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as <strong>\\"schemas_allowed_for_file_upload\\": [\\"public\\", \\"csv_upload\\"]</strong>. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty<br>4. The <code>version</code> field is a string specifying the this db\'s version. This should be used with Presto DBs so that the syntax is correct<br>5. The <code>allows_virtual_table_explore</code> field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.<br>6. The <code>disable_data_preview</code> field is a boolean specifying whether or not data preview queries will be run when fetching table metadata in SQL Lab.</p>","type":"string"},"id":{"description":"Database ID (for updates)","nullable":true,"type":"integer"},"impersonate_user":{"description":"If Presto, all the queries in SQL Lab are going to be executed as the currently logged on user who must have permission to run them.<br/>If Hive and hive.server2.enable.doAs is enabled, will run the queries as service account, but impersonate the currently logged on user via hive.server2.proxy.user property.","type":"boolean"},"masked_encrypted_extra":{"description":"<p>JSON string containing additional connection configuration.<br>This is used to provide connection information for systems like Hive, Presto, and BigQuery, which do not conform to the username:password syntax normally used by SQLAlchemy.</p>","nullable":true,"type":"string"},"parameters":{"additionalProperties":{"nullable":true},"description":"DB-specific parameters for configuration","type":"object"},"server_cert":{"description":"<p>Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.</p>","nullable":true,"type":"string"}},"required":["configuration_method","engine"],"type":"object"},"Dataset":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this dataset.","type":"integer"},"column_formats":{"description":"Column formats.","type":"object"},"columns":{"description":"Columns metadata.","items":{"type":"object"},"type":"array"},"currency_formats":{"description":"Currency formats.","type":"object"},"database":{"description":"Database associated with the dataset.","type":"object"},"datasource_name":{"description":"Dataset name.","type":"string"},"default_endpoint":{"description":"Default endpoint for the dataset.","type":"string"},"description":{"description":"Dataset description.","type":"string"},"edit_url":{"description":"The URL for editing the dataset.","type":"string"},"extra":{"description":"JSON string containing extra configuration elements.","type":"object"},"fetch_values_predicate":{"description":"Predicate used when fetching values from the dataset.","type":"string"},"filter_select":{"description":"SELECT filter applied to the dataset.","type":"boolean"},"filter_select_enabled":{"description":"If the SELECT filter is enabled.","type":"boolean"},"granularity_sqla":{"description":"Name of temporal column used for time filtering for SQL datasources. This field is deprecated, use `granularity` instead.","items":{"items":{"type":"object"},"type":"array"},"type":"array"},"health_check_message":{"description":"Health check message.","type":"string"},"id":{"description":"Dataset ID.","type":"integer"},"is_sqllab_view":{"description":"If the dataset is a SQL Lab view.","type":"boolean"},"main_dttm_col":{"description":"The main temporal column.","type":"string"},"metrics":{"description":"Dataset metrics.","items":{"type":"object"},"type":"array"},"name":{"description":"Dataset name.","type":"string"},"offset":{"description":"Dataset offset.","type":"integer"},"order_by_choices":{"description":"List of order by columns.","items":{"items":{"type":"string"},"type":"array"},"type":"array"},"owners":{"description":"List of owners identifiers","items":{"type":"integer"},"type":"array"},"params":{"description":"Extra params for the dataset.","type":"object"},"perm":{"description":"Permission expression.","type":"string"},"schema":{"description":"Dataset schema.","type":"string"},"select_star":{"description":"Select all clause.","type":"string"},"sql":{"description":"A SQL statement that defines the dataset.","type":"string"},"table_name":{"description":"The name of the table associated with the dataset.","type":"string"},"template_params":{"description":"Table template params.","type":"object"},"time_grain_sqla":{"description":"List of temporal granularities supported by the dataset.","items":{"items":{"type":"string"},"type":"array"},"type":"array"},"type":{"description":"Dataset type.","type":"string"},"uid":{"description":"Dataset unique identifier.","type":"string"},"verbose_map":{"description":"Mapping from raw name to verbose name.","type":"object"}},"type":"object"},"DatasetCacheWarmUpRequestSchema":{"properties":{"dashboard_id":{"description":"The ID of the dashboard to get filters for when warming cache","type":"integer"},"db_name":{"description":"The name of the database where the table is located","type":"string"},"extra_filters":{"description":"Extra filters to apply when warming up cache","type":"string"},"table_name":{"description":"The name of the table to warm up cache for","type":"string"}},"required":["db_name","table_name"],"type":"object"},"DatasetCacheWarmUpResponseSchema":{"properties":{"result":{"description":"A list of each chart\'s warmup status and errors if any","items":{"$ref":"#/components/schemas/DatasetCacheWarmUpResponseSingle"},"type":"array"}},"type":"object"},"DatasetCacheWarmUpResponseSingle":{"properties":{"chart_id":{"description":"The ID of the chart the status belongs to","type":"integer"},"viz_error":{"description":"Error that occurred when warming cache for chart","type":"string"},"viz_status":{"description":"Status of the underlying query for the viz","type":"string"}},"type":"object"},"DatasetColumnsPut":{"properties":{"advanced_data_type":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"column_name":{"maxLength":255,"minLength":1,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"filterable":{"type":"boolean"},"groupby":{"type":"boolean"},"id":{"type":"integer"},"is_active":{"nullable":true,"type":"boolean"},"is_dttm":{"nullable":true,"type":"boolean"},"python_date_format":{"maxLength":255,"minLength":1,"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"nullable":true,"type":"string"}},"required":["column_name"],"type":"object"},"DatasetColumnsRestApi.get":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetColumnsRestApi.get_list":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetColumnsRestApi.post":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetColumnsRestApi.put":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetDuplicateSchema":{"properties":{"base_model_id":{"type":"integer"},"table_name":{"maxLength":250,"minLength":1,"type":"string"}},"required":["base_model_id","table_name"],"type":"object"},"DatasetMetricRestApi.get":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetMetricRestApi.get_list":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetMetricRestApi.post":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetMetricRestApi.put":{"properties":{"id":{"type":"integer"}},"type":"object"},"DatasetMetricsPut":{"properties":{"currency":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"d3format":{"maxLength":128,"minLength":1,"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"type":"string"},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"metric_name":{"maxLength":255,"minLength":1,"type":"string"},"metric_type":{"maxLength":32,"minLength":1,"nullable":true,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"nullable":true,"type":"string"},"warning_text":{"nullable":true,"type":"string"}},"required":["expression","metric_name"],"type":"object"},"DatasetRelatedChart":{"properties":{"id":{"type":"integer"},"slice_name":{"type":"string"},"viz_type":{"type":"string"}},"type":"object"},"DatasetRelatedCharts":{"properties":{"count":{"description":"Chart count","type":"integer"},"result":{"description":"A list of dashboards","items":{"$ref":"#/components/schemas/DatasetRelatedChart"},"type":"array"}},"type":"object"},"DatasetRelatedDashboard":{"properties":{"id":{"type":"integer"},"json_metadata":{"type":"object"},"slug":{"type":"string"},"title":{"type":"string"}},"type":"object"},"DatasetRelatedDashboards":{"properties":{"count":{"description":"Dashboard count","type":"integer"},"result":{"description":"A list of dashboards","items":{"$ref":"#/components/schemas/DatasetRelatedDashboard"},"type":"array"}},"type":"object"},"DatasetRelatedObjectsResponse":{"properties":{"charts":{"$ref":"#/components/schemas/DatasetRelatedCharts"},"dashboards":{"$ref":"#/components/schemas/DatasetRelatedDashboards"}},"type":"object"},"DatasetRestApi.get":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"changed_by":{"$ref":"#/components/schemas/DatasetRestApi.get.User2"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_humanized":{"readOnly":true},"column_formats":{"readOnly":true},"columns":{"$ref":"#/components/schemas/DatasetRestApi.get.TableColumn"},"created_by":{"$ref":"#/components/schemas/DatasetRestApi.get.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"created_on_humanized":{"readOnly":true},"currency_formats":{"readOnly":true},"database":{"$ref":"#/components/schemas/DatasetRestApi.get.Database"},"datasource_name":{"readOnly":true},"datasource_type":{"readOnly":true},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"fetch_values_predicate":{"nullable":true,"type":"string"},"filter_select_enabled":{"nullable":true,"type":"boolean"},"granularity_sqla":{"readOnly":true},"id":{"type":"integer"},"is_managed_externally":{"type":"boolean"},"is_sqllab_view":{"nullable":true,"type":"boolean"},"kind":{"readOnly":true},"main_dttm_col":{"maxLength":250,"nullable":true,"type":"string"},"metrics":{"$ref":"#/components/schemas/DatasetRestApi.get.SqlMetric"},"name":{"readOnly":true},"offset":{"nullable":true,"type":"integer"},"order_by_choices":{"readOnly":true},"owners":{"$ref":"#/components/schemas/DatasetRestApi.get.User1"},"schema":{"maxLength":255,"nullable":true,"type":"string"},"select_star":{"readOnly":true},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"},"template_params":{"nullable":true,"type":"string"},"time_grain_sqla":{"readOnly":true},"uid":{"readOnly":true},"url":{"readOnly":true},"verbose_map":{"readOnly":true}},"required":["columns","database","metrics","table_name"],"type":"object"},"DatasetRestApi.get.Database":{"properties":{"backend":{"readOnly":true},"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object"},"DatasetRestApi.get.SqlMetric":{"properties":{"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"currency":{"maxLength":128,"nullable":true,"type":"string"},"d3format":{"maxLength":128,"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"type":"string"},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"metric_name":{"maxLength":255,"type":"string"},"metric_type":{"maxLength":32,"nullable":true,"type":"string"},"verbose_name":{"maxLength":1024,"nullable":true,"type":"string"},"warning_text":{"nullable":true,"type":"string"}},"required":["expression","metric_name"],"type":"object"},"DatasetRestApi.get.TableColumn":{"properties":{"advanced_data_type":{"maxLength":255,"nullable":true,"type":"string"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"column_name":{"maxLength":255,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"expression":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"filterable":{"nullable":true,"type":"boolean"},"groupby":{"nullable":true,"type":"boolean"},"id":{"type":"integer"},"is_active":{"nullable":true,"type":"boolean"},"is_dttm":{"nullable":true,"type":"boolean"},"python_date_format":{"maxLength":255,"nullable":true,"type":"string"},"type":{"nullable":true,"type":"string"},"type_generic":{"readOnly":true},"uuid":{"format":"uuid","nullable":true,"type":"string"},"verbose_name":{"maxLength":1024,"nullable":true,"type":"string"}},"required":["column_name"],"type":"object"},"DatasetRestApi.get.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DatasetRestApi.get.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DatasetRestApi.get.User2":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DatasetRestApi.get_list":{"properties":{"changed_by":{"$ref":"#/components/schemas/DatasetRestApi.get_list.User1"},"changed_by_name":{"readOnly":true},"changed_on_delta_humanized":{"readOnly":true},"changed_on_utc":{"readOnly":true},"database":{"$ref":"#/components/schemas/DatasetRestApi.get_list.Database"},"datasource_type":{"readOnly":true},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"explore_url":{"readOnly":true},"extra":{"nullable":true,"type":"string"},"id":{"type":"integer"},"kind":{"readOnly":true},"owners":{"$ref":"#/components/schemas/DatasetRestApi.get_list.User"},"schema":{"maxLength":255,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"type":"string"}},"required":["database","table_name"],"type":"object"},"DatasetRestApi.get_list.Database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object"},"DatasetRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DatasetRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"DatasetRestApi.post":{"properties":{"database":{"type":"integer"},"external_url":{"nullable":true,"type":"string"},"is_managed_externally":{"nullable":true,"type":"boolean"},"owners":{"items":{"type":"integer"},"type":"array"},"schema":{"maxLength":250,"minLength":0,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"minLength":1,"type":"string"}},"required":["database","table_name"],"type":"object"},"DatasetRestApi.put":{"properties":{"cache_timeout":{"nullable":true,"type":"integer"},"columns":{"items":{"$ref":"#/components/schemas/DatasetColumnsPut"},"type":"array"},"database_id":{"type":"integer"},"default_endpoint":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"external_url":{"nullable":true,"type":"string"},"extra":{"nullable":true,"type":"string"},"fetch_values_predicate":{"maxLength":1000,"minLength":0,"nullable":true,"type":"string"},"filter_select_enabled":{"nullable":true,"type":"boolean"},"is_managed_externally":{"nullable":true,"type":"boolean"},"is_sqllab_view":{"nullable":true,"type":"boolean"},"main_dttm_col":{"nullable":true,"type":"string"},"metrics":{"items":{"$ref":"#/components/schemas/DatasetMetricsPut"},"type":"array"},"offset":{"nullable":true,"type":"integer"},"owners":{"items":{"type":"integer"},"type":"array"},"schema":{"maxLength":255,"minLength":0,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"table_name":{"maxLength":250,"minLength":1,"nullable":true,"type":"string"},"template_params":{"nullable":true,"type":"string"}},"type":"object"},"Datasource":{"properties":{"database_name":{"description":"Datasource name","type":"string"},"datasource_name":{"description":"The datasource name.","type":"string"},"datasource_type":{"description":"The type of dataset/datasource identified on `datasource_id`.","enum":["sl_table","table","dataset","query","saved_query","view"],"type":"string"},"schema":{"description":"Datasource schema","type":"string"}},"required":["datasource_type"],"type":"object"},"DistincResponseSchema":{"properties":{"count":{"description":"The total number of distinct values","type":"integer"},"result":{"items":{"$ref":"#/components/schemas/DistinctResultResponse"},"type":"array"}},"type":"object"},"DistinctResultResponse":{"properties":{"text":{"description":"The distinct item","type":"string"}},"type":"object"},"EmbeddedDashboardConfig":{"properties":{"allowed_domains":{"items":{"type":"string"},"type":"array"}},"required":["allowed_domains"],"type":"object"},"EmbeddedDashboardResponseSchema":{"properties":{"allowed_domains":{"items":{"type":"string"},"type":"array"},"changed_by":{"$ref":"#/components/schemas/User1"},"changed_on":{"format":"date-time","type":"string"},"dashboard_id":{"type":"string"},"uuid":{"type":"string"}},"type":"object"},"EmbeddedDashboardRestApi.get":{"properties":{"uuid":{"format":"uuid","type":"string"}},"type":"object"},"EmbeddedDashboardRestApi.get_list":{"properties":{"uuid":{"format":"uuid","type":"string"}},"type":"object"},"EmbeddedDashboardRestApi.post":{"properties":{"uuid":{"format":"uuid","type":"string"}},"type":"object"},"EmbeddedDashboardRestApi.put":{"properties":{"uuid":{"format":"uuid","type":"string"}},"type":"object"},"EstimateQueryCostSchema":{"properties":{"database_id":{"description":"The database id","type":"integer"},"schema":{"description":"The database schema","nullable":true,"type":"string"},"sql":{"description":"The SQL query to estimate","type":"string"},"template_params":{"description":"The SQL query template params","type":"object"}},"required":["database_id","sql"],"type":"object"},"ExecutePayloadSchema":{"properties":{"client_id":{"nullable":true,"type":"string"},"ctas_method":{"nullable":true,"type":"string"},"database_id":{"type":"integer"},"expand_data":{"nullable":true,"type":"boolean"},"json":{"nullable":true,"type":"boolean"},"queryLimit":{"nullable":true,"type":"integer"},"runAsync":{"nullable":true,"type":"boolean"},"schema":{"nullable":true,"type":"string"},"select_as_cta":{"nullable":true,"type":"boolean"},"sql":{"type":"string"},"sql_editor_id":{"nullable":true,"type":"string"},"tab":{"nullable":true,"type":"string"},"templateParams":{"nullable":true,"type":"string"},"tmp_table_name":{"nullable":true,"type":"string"}},"required":["database_id","sql"],"type":"object"},"ExploreContextSchema":{"properties":{"dataset":{"$ref":"#/components/schemas/Dataset"},"form_data":{"description":"Form data from the Explore controls used to form the chart\'s data query.","type":"object"},"message":{"description":"Any message related to the processed request.","type":"string"},"slice":{"$ref":"#/components/schemas/Slice"}},"type":"object"},"ExplorePermalinkStateSchema":{"properties":{"formData":{"description":"Chart form data","type":"object"},"urlParams":{"description":"URL Parameters","items":{"description":"URL Parameter key-value pair","nullable":true},"nullable":true,"type":"array"}},"required":["formData"],"type":"object"},"FilterSetRestApi.get":{"properties":{"dashboard_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":500,"type":"string"},"owner_id":{"type":"integer"},"owner_type":{"maxLength":255,"type":"string"},"params":{"readOnly":true}},"required":["name","owner_id","owner_type"],"type":"object"},"FilterSetRestApi.get_list":{"properties":{"changed_by_fk":{"nullable":true,"type":"integer"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_by_fk":{"nullable":true,"type":"integer"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"dashboard_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"name":{"maxLength":500,"type":"string"},"owner_id":{"type":"integer"},"owner_type":{"maxLength":255,"type":"string"},"params":{"readOnly":true}},"required":["name","owner_id","owner_type"],"type":"object"},"FilterSetRestApi.post":{"properties":{"description":{"maxLength":1000,"minLength":1,"nullable":true,"type":"string"},"json_metadata":{"type":"string"},"name":{"maxLength":500,"minLength":0,"type":"string"},"owner_id":{"type":"integer"},"owner_type":{"enum":["User","Dashboard"],"type":"string"}},"required":["json_metadata","name","owner_type"],"type":"object"},"FilterSetRestApi.put":{"properties":{"description":{"maxLength":1000,"minLength":1,"type":"string"},"json_metadata":{"type":"string"},"name":{"maxLength":500,"minLength":0,"type":"string"},"owner_type":{"enum":["Dashboard"],"type":"string"}},"type":"object"},"FormDataPostSchema":{"properties":{"chart_id":{"description":"The chart ID","type":"integer"},"datasource_id":{"description":"The datasource ID","type":"integer"},"datasource_type":{"description":"The datasource type","enum":["sl_table","table","dataset","query","saved_query","view"],"type":"string"},"form_data":{"description":"Any type of JSON supported text.","type":"string"}},"required":["datasource_id","datasource_type","form_data"],"type":"object"},"FormDataPutSchema":{"properties":{"chart_id":{"description":"The chart ID","type":"integer"},"datasource_id":{"description":"The datasource ID","type":"integer"},"datasource_type":{"description":"The datasource type","enum":["sl_table","table","dataset","query","saved_query","view"],"type":"string"},"form_data":{"description":"Any type of JSON supported text.","type":"string"}},"required":["datasource_id","datasource_type","form_data"],"type":"object"},"GetFavStarIdsSchema":{"properties":{"result":{"description":"A list of results for each corresponding chart in the request","items":{"$ref":"#/components/schemas/ChartFavStarResponseResult"},"type":"array"}},"type":"object"},"GetOrCreateDatasetSchema":{"properties":{"database_id":{"description":"ID of database table belongs to","type":"integer"},"schema":{"description":"The schema the table belongs to","maxLength":250,"minLength":0,"nullable":true,"type":"string"},"table_name":{"description":"Name of table","type":"string"},"template_params":{"description":"Template params for the table","type":"string"}},"required":["database_id","table_name"],"type":"object"},"GuestTokenCreate":{"properties":{"resources":{"items":{"$ref":"#/components/schemas/Resource"},"type":"array"},"rls":{"items":{"$ref":"#/components/schemas/RlsRule"},"type":"array"},"user":{"$ref":"#/components/schemas/User2"}},"required":["resources","rls"],"type":"object"},"LogRestApi.get":{"properties":{"action":{"maxLength":512,"nullable":true,"type":"string"},"dashboard_id":{"nullable":true,"type":"integer"},"dttm":{"format":"date-time","nullable":true,"type":"string"},"duration_ms":{"nullable":true,"type":"integer"},"json":{"nullable":true,"type":"string"},"referrer":{"maxLength":1024,"nullable":true,"type":"string"},"slice_id":{"nullable":true,"type":"integer"},"user":{"$ref":"#/components/schemas/LogRestApi.get.User"},"user_id":{"nullable":true,"type":"integer"}},"type":"object"},"LogRestApi.get.User":{"properties":{"username":{"maxLength":64,"type":"string"}},"required":["username"],"type":"object"},"LogRestApi.get_list":{"properties":{"action":{"maxLength":512,"nullable":true,"type":"string"},"dashboard_id":{"nullable":true,"type":"integer"},"dttm":{"format":"date-time","nullable":true,"type":"string"},"duration_ms":{"nullable":true,"type":"integer"},"json":{"nullable":true,"type":"string"},"referrer":{"maxLength":1024,"nullable":true,"type":"string"},"slice_id":{"nullable":true,"type":"integer"},"user":{"$ref":"#/components/schemas/LogRestApi.get_list.User"},"user_id":{"nullable":true,"type":"integer"}},"type":"object"},"LogRestApi.get_list.User":{"properties":{"username":{"maxLength":64,"type":"string"}},"required":["username"],"type":"object"},"LogRestApi.post":{"properties":{"id":{"type":"integer"}},"type":"object"},"LogRestApi.put":{"properties":{"action":{"maxLength":512,"nullable":true,"type":"string"},"dttm":{"format":"date-time","nullable":true,"type":"string"},"json":{"nullable":true,"type":"string"},"user":{"nullable":true}},"type":"object"},"QueryExecutionResponseSchema":{"properties":{"columns":{"items":{"type":"object"},"type":"array"},"data":{"items":{"type":"object"},"type":"array"},"expanded_columns":{"items":{"type":"object"},"type":"array"},"query":{"$ref":"#/components/schemas/QueryResult"},"query_id":{"type":"integer"},"selected_columns":{"items":{"type":"object"},"type":"array"},"status":{"type":"string"}},"type":"object"},"QueryRestApi.get":{"properties":{"changed_on":{"format":"date-time","nullable":true,"type":"string"},"client_id":{"maxLength":11,"type":"string"},"database":{"$ref":"#/components/schemas/QueryRestApi.get.Database"},"end_result_backend_time":{"nullable":true,"type":"number"},"end_time":{"nullable":true,"type":"number"},"error_message":{"nullable":true,"type":"string"},"executed_sql":{"nullable":true,"type":"string"},"id":{"type":"integer"},"limit":{"nullable":true,"type":"integer"},"progress":{"nullable":true,"type":"integer"},"results_key":{"maxLength":64,"nullable":true,"type":"string"},"rows":{"nullable":true,"type":"integer"},"schema":{"maxLength":256,"nullable":true,"type":"string"},"select_as_cta":{"nullable":true,"type":"boolean"},"select_as_cta_used":{"nullable":true,"type":"boolean"},"select_sql":{"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_editor_id":{"maxLength":256,"nullable":true,"type":"string"},"start_running_time":{"nullable":true,"type":"number"},"start_time":{"nullable":true,"type":"number"},"status":{"maxLength":16,"nullable":true,"type":"string"},"tab_name":{"maxLength":256,"nullable":true,"type":"string"},"tmp_schema_name":{"maxLength":256,"nullable":true,"type":"string"},"tmp_table_name":{"maxLength":256,"nullable":true,"type":"string"},"tracking_url":{"readOnly":true}},"required":["client_id","database"],"type":"object"},"QueryRestApi.get.Database":{"properties":{"id":{"type":"integer"}},"type":"object"},"QueryRestApi.get_list":{"properties":{"changed_on":{"format":"date-time","type":"string"},"database":{"$ref":"#/components/schemas/Database1"},"end_time":{"type":"number"},"executed_sql":{"type":"string"},"id":{"type":"integer"},"rows":{"type":"integer"},"schema":{"type":"string"},"sql":{"type":"string"},"sql_tables":{"readOnly":true},"start_time":{"type":"number"},"status":{"type":"string"},"tab_name":{"type":"string"},"tmp_table_name":{"type":"string"},"tracking_url":{"type":"string"},"user":{"$ref":"#/components/schemas/User"}},"type":"object"},"QueryRestApi.post":{"properties":{"id":{"type":"integer"}},"type":"object"},"QueryRestApi.put":{"properties":{"id":{"type":"integer"}},"type":"object"},"QueryResult":{"properties":{"changed_on":{"format":"date-time","type":"string"},"ctas":{"type":"boolean"},"db":{"type":"string"},"dbId":{"type":"integer"},"endDttm":{"type":"number"},"errorMessage":{"nullable":true,"type":"string"},"executedSql":{"type":"string"},"extra":{"type":"object"},"id":{"type":"string"},"limit":{"type":"integer"},"limitingFactor":{"type":"string"},"progress":{"type":"integer"},"queryId":{"type":"integer"},"resultsKey":{"type":"string"},"rows":{"type":"integer"},"schema":{"type":"string"},"serverId":{"type":"integer"},"sql":{"type":"string"},"sqlEditorId":{"type":"string"},"startDttm":{"type":"number"},"state":{"type":"string"},"tab":{"type":"string"},"tempSchema":{"nullable":true,"type":"string"},"tempTable":{"nullable":true,"type":"string"},"trackingUrl":{"nullable":true,"type":"string"},"user":{"type":"string"},"userId":{"type":"integer"}},"type":"object"},"RLSRestApi.get":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","type":"string"},"id":{"description":"id_description","type":"integer"},"name":{"description":"name_description","type":"string"},"roles":{"items":{"$ref":"#/components/schemas/Roles1"},"type":"array"},"tables":{"items":{"$ref":"#/components/schemas/Tables"},"type":"array"}},"type":"object"},"RLSRestApi.get_list":{"properties":{"changed_on_delta_humanized":{"readOnly":true},"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","type":"string"},"id":{"description":"id_description","type":"integer"},"name":{"description":"name_description","type":"string"},"roles":{"items":{"$ref":"#/components/schemas/Roles1"},"type":"array"},"tables":{"items":{"$ref":"#/components/schemas/Tables"},"type":"array"}},"type":"object"},"RLSRestApi.post":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","nullable":true,"type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","nullable":true,"type":"string"},"name":{"description":"name_description","maxLength":255,"minLength":1,"type":"string"},"roles":{"description":"roles_description","items":{"type":"integer"},"type":"array"},"tables":{"description":"tables_description","items":{"type":"integer"},"minItems":1,"type":"array"}},"required":["clause","filter_type","name","roles","tables"],"type":"object"},"RLSRestApi.put":{"properties":{"clause":{"description":"clause_description","type":"string"},"description":{"description":"description_description","nullable":true,"type":"string"},"filter_type":{"description":"filter_type_description","enum":["Regular","Base"],"type":"string"},"group_key":{"description":"group_key_description","nullable":true,"type":"string"},"name":{"description":"name_description","maxLength":255,"minLength":1,"type":"string"},"roles":{"description":"roles_description","items":{"type":"integer"},"type":"array"},"tables":{"description":"tables_description","items":{"type":"integer"},"type":"array"}},"type":"object"},"RecentActivity":{"properties":{"action":{"description":"Action taken describing type of activity","type":"string"},"item_title":{"description":"Title of item","type":"string"},"item_type":{"description":"Type of item, e.g. slice or dashboard","type":"string"},"item_url":{"description":"URL to item","type":"string"},"time":{"description":"Time of activity, in epoch milliseconds","type":"number"},"time_delta_humanized":{"description":"Human-readable description of how long ago activity took place.","type":"string"}},"type":"object"},"RecentActivityResponseSchema":{"properties":{"result":{"description":"A list of recent activity objects","items":{"$ref":"#/components/schemas/RecentActivity"},"type":"array"}},"type":"object"},"RecentActivitySchema":{"properties":{"action":{"description":"Action taken describing type of activity","type":"string"},"item_title":{"description":"Title of item","type":"string"},"item_type":{"description":"Type of item, e.g. slice or dashboard","type":"string"},"item_url":{"description":"URL to item","type":"string"},"time":{"description":"Time of activity, in epoch milliseconds","type":"number"},"time_delta_humanized":{"description":"Human-readable description of how long ago activity took place.","type":"string"}},"type":"object"},"RelatedResponseSchema":{"properties":{"count":{"description":"The total number of related values","type":"integer"},"result":{"items":{"$ref":"#/components/schemas/RelatedResultResponse"},"type":"array"}},"type":"object"},"RelatedResultResponse":{"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"},"ReportExecutionLogRestApi.get":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"id":{"type":"integer"},"scheduled_dttm":{"format":"date-time","type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"},"state":{"maxLength":50,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"value":{"nullable":true,"type":"number"},"value_row_json":{"nullable":true,"type":"string"}},"required":["scheduled_dttm","state"],"type":"object"},"ReportExecutionLogRestApi.get_list":{"properties":{"end_dttm":{"format":"date-time","nullable":true,"type":"string"},"error_message":{"nullable":true,"type":"string"},"id":{"type":"integer"},"scheduled_dttm":{"format":"date-time","type":"string"},"start_dttm":{"format":"date-time","nullable":true,"type":"string"},"state":{"maxLength":50,"type":"string"},"uuid":{"format":"uuid","nullable":true,"type":"string"},"value":{"nullable":true,"type":"number"},"value_row_json":{"nullable":true,"type":"string"}},"required":["scheduled_dttm","state"],"type":"object"},"ReportExecutionLogRestApi.post":{"properties":{"id":{"type":"integer"}},"type":"object"},"ReportExecutionLogRestApi.put":{"properties":{"id":{"type":"integer"}},"type":"object"},"ReportRecipient":{"properties":{"recipient_config_json":{"$ref":"#/components/schemas/ReportRecipientConfigJSON"},"type":{"description":"The recipient type, check spec for valid options","enum":["Email","Slack"],"type":"string"}},"required":["type"],"type":"object"},"ReportRecipientConfigJSON":{"properties":{"target":{"type":"string"}},"type":"object"},"ReportScheduleRestApi.get":{"properties":{"active":{"nullable":true,"type":"boolean"},"chart":{"$ref":"#/components/schemas/ReportScheduleRestApi.get.Slice"},"context_markdown":{"nullable":true,"type":"string"},"creation_method":{"maxLength":255,"nullable":true,"type":"string"},"crontab":{"maxLength":1000,"type":"string"},"custom_width":{"nullable":true,"type":"integer"},"dashboard":{"$ref":"#/components/schemas/ReportScheduleRestApi.get.Dashboard"},"database":{"$ref":"#/components/schemas/ReportScheduleRestApi.get.Database"},"description":{"nullable":true,"type":"string"},"extra":{"readOnly":true},"force_screenshot":{"nullable":true,"type":"boolean"},"grace_period":{"nullable":true,"type":"integer"},"id":{"type":"integer"},"last_eval_dttm":{"format":"date-time","nullable":true,"type":"string"},"last_state":{"maxLength":50,"nullable":true,"type":"string"},"last_value":{"nullable":true,"type":"number"},"last_value_row_json":{"nullable":true,"type":"string"},"log_retention":{"nullable":true,"type":"integer"},"name":{"maxLength":150,"type":"string"},"owners":{"$ref":"#/components/schemas/ReportScheduleRestApi.get.User"},"recipients":{"$ref":"#/components/schemas/ReportScheduleRestApi.get.ReportRecipients"},"report_format":{"maxLength":50,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"timezone":{"maxLength":100,"type":"string"},"type":{"maxLength":50,"type":"string"},"validator_config_json":{"nullable":true,"type":"string"},"validator_type":{"maxLength":100,"nullable":true,"type":"string"},"working_timeout":{"nullable":true,"type":"integer"}},"required":["crontab","name","recipients","type"],"type":"object"},"ReportScheduleRestApi.get.Dashboard":{"properties":{"dashboard_title":{"maxLength":500,"nullable":true,"type":"string"},"id":{"type":"integer"}},"type":"object"},"ReportScheduleRestApi.get.Database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object"},"ReportScheduleRestApi.get.ReportRecipients":{"properties":{"id":{"type":"integer"},"recipient_config_json":{"nullable":true,"type":"string"},"type":{"maxLength":50,"type":"string"}},"required":["type"],"type":"object"},"ReportScheduleRestApi.get.Slice":{"properties":{"id":{"type":"integer"},"slice_name":{"maxLength":250,"nullable":true,"type":"string"},"viz_type":{"maxLength":250,"nullable":true,"type":"string"}},"type":"object"},"ReportScheduleRestApi.get.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ReportScheduleRestApi.get_list":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_by":{"$ref":"#/components/schemas/ReportScheduleRestApi.get_list.User2"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"changed_on_delta_humanized":{"readOnly":true},"chart_id":{"nullable":true,"type":"integer"},"created_by":{"$ref":"#/components/schemas/ReportScheduleRestApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"creation_method":{"maxLength":255,"nullable":true,"type":"string"},"crontab":{"maxLength":1000,"type":"string"},"crontab_humanized":{"readOnly":true},"dashboard_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra":{"readOnly":true},"id":{"type":"integer"},"last_eval_dttm":{"format":"date-time","nullable":true,"type":"string"},"last_state":{"maxLength":50,"nullable":true,"type":"string"},"name":{"maxLength":150,"type":"string"},"owners":{"$ref":"#/components/schemas/ReportScheduleRestApi.get_list.User1"},"recipients":{"$ref":"#/components/schemas/ReportScheduleRestApi.get_list.ReportRecipients"},"timezone":{"maxLength":100,"type":"string"},"type":{"maxLength":50,"type":"string"}},"required":["crontab","name","recipients","type"],"type":"object"},"ReportScheduleRestApi.get_list.ReportRecipients":{"properties":{"id":{"type":"integer"},"type":{"maxLength":50,"type":"string"}},"required":["type"],"type":"object"},"ReportScheduleRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ReportScheduleRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ReportScheduleRestApi.get_list.User2":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"ReportScheduleRestApi.post":{"properties":{"active":{"type":"boolean"},"chart":{"nullable":true,"type":"integer"},"context_markdown":{"description":"Markdown description","nullable":true,"type":"string"},"creation_method":{"description":"Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.","enum":["charts","dashboards","alerts_reports"]},"crontab":{"description":"A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.","example":"*/5 * * * *","maxLength":1000,"minLength":1,"type":"string"},"custom_width":{"description":"Custom width of the screenshot in pixels","example":1000,"nullable":true,"type":"integer"},"dashboard":{"nullable":true,"type":"integer"},"database":{"type":"integer"},"description":{"description":"Use a nice description to give context to this Alert/Report","example":"Daily sales dashboard to marketing","nullable":true,"type":"string"},"extra":{"type":"object"},"force_screenshot":{"type":"boolean"},"grace_period":{"description":"Once an alert is triggered, how long, in seconds, before Superset nags you again. (in seconds)","example":14400,"minimum":1,"type":"integer"},"log_retention":{"description":"How long to keep the logs around for this report (in days)","example":90,"minimum":1,"type":"integer"},"name":{"description":"The report schedule name.","example":"Daily dashboard email","maxLength":150,"minLength":1,"type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this report. If left empty you will be one of the owners of the report.","type":"integer"},"type":"array"},"recipients":{"items":{"$ref":"#/components/schemas/ReportRecipient"},"type":"array"},"report_format":{"enum":["PNG","CSV","TEXT"],"type":"string"},"selected_tabs":{"items":{"type":"integer"},"nullable":true,"type":"array"},"sql":{"description":"A SQL statement that defines whether the alert should get triggered or not. The query is expected to return either NULL or a number value.","example":"SELECT value FROM time_series_table","type":"string"},"timezone":{"description":"A timezone string that represents the location of the timezone.","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"type":"string"},"type":{"description":"The report schedule type","enum":["Alert","Report"],"type":"string"},"validator_config_json":{"$ref":"#/components/schemas/ValidatorConfigJSON"},"validator_type":{"description":"Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\\n- Not Null - When the return value is Not NULL, Empty, or 0\\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`<br>Supports the comparison operators <, <=, >, >=, ==, and !=","enum":["not null","operator"],"type":"string"},"working_timeout":{"description":"If an alert is staled at a working state, how long until it\'s state is reseted to error","example":3600,"minimum":1,"type":"integer"}},"required":["crontab","name","type"],"type":"object"},"ReportScheduleRestApi.put":{"properties":{"active":{"type":"boolean"},"chart":{"nullable":true,"type":"integer"},"context_markdown":{"description":"Markdown description","nullable":true,"type":"string"},"creation_method":{"description":"Creation method is used to inform the frontend whether the report/alert was created in the dashboard, chart, or alerts and reports UI.","enum":["charts","dashboards","alerts_reports"],"nullable":true},"crontab":{"description":"A CRON expression.[Crontab Guru](https://crontab.guru/) is a helpful resource that can help you craft a CRON expression.","maxLength":1000,"minLength":1,"type":"string"},"custom_width":{"description":"Custom width of the screenshot in pixels","example":1000,"nullable":true,"type":"integer"},"dashboard":{"nullable":true,"type":"integer"},"database":{"type":"integer"},"description":{"description":"Use a nice description to give context to this Alert/Report","example":"Daily sales dashboard to marketing","nullable":true,"type":"string"},"extra":{"type":"object"},"force_screenshot":{"type":"boolean"},"grace_period":{"description":"Once an alert is triggered, how long, in seconds, before Superset nags you again. (in seconds)","example":14400,"minimum":1,"type":"integer"},"log_retention":{"description":"How long to keep the logs around for this report (in days)","example":90,"minimum":1,"type":"integer"},"name":{"description":"The report schedule name.","maxLength":150,"minLength":1,"type":"string"},"owners":{"items":{"description":"Owner are users ids allowed to delete or change this report. If left empty you will be one of the owners of the report.","type":"integer"},"type":"array"},"recipients":{"items":{"$ref":"#/components/schemas/ReportRecipient"},"type":"array"},"report_format":{"enum":["PNG","CSV","TEXT"],"type":"string"},"sql":{"description":"A SQL statement that defines whether the alert should get triggered or not. The query is expected to return either NULL or a number value.","example":"SELECT value FROM time_series_table","nullable":true,"type":"string"},"timezone":{"description":"A timezone string that represents the location of the timezone.","enum":["Africa/Abidjan","Africa/Accra","Africa/Addis_Ababa","Africa/Algiers","Africa/Asmara","Africa/Asmera","Africa/Bamako","Africa/Bangui","Africa/Banjul","Africa/Bissau","Africa/Blantyre","Africa/Brazzaville","Africa/Bujumbura","Africa/Cairo","Africa/Casablanca","Africa/Ceuta","Africa/Conakry","Africa/Dakar","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Douala","Africa/El_Aaiun","Africa/Freetown","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Juba","Africa/Kampala","Africa/Khartoum","Africa/Kigali","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Lome","Africa/Luanda","Africa/Lubumbashi","Africa/Lusaka","Africa/Malabo","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Mogadishu","Africa/Monrovia","Africa/Nairobi","Africa/Ndjamena","Africa/Niamey","Africa/Nouakchott","Africa/Ouagadougou","Africa/Porto-Novo","Africa/Sao_Tome","Africa/Timbuktu","Africa/Tripoli","Africa/Tunis","Africa/Windhoek","America/Adak","America/Anchorage","America/Anguilla","America/Antigua","America/Araguaina","America/Argentina/Buenos_Aires","America/Argentina/Catamarca","America/Argentina/ComodRivadavia","America/Argentina/Cordoba","America/Argentina/Jujuy","America/Argentina/La_Rioja","America/Argentina/Mendoza","America/Argentina/Rio_Gallegos","America/Argentina/Salta","America/Argentina/San_Juan","America/Argentina/San_Luis","America/Argentina/Tucuman","America/Argentina/Ushuaia","America/Aruba","America/Asuncion","America/Atikokan","America/Atka","America/Bahia","America/Bahia_Banderas","America/Barbados","America/Belem","America/Belize","America/Blanc-Sablon","America/Boa_Vista","America/Bogota","America/Boise","America/Buenos_Aires","America/Cambridge_Bay","America/Campo_Grande","America/Cancun","America/Caracas","America/Catamarca","America/Cayenne","America/Cayman","America/Chicago","America/Chihuahua","America/Coral_Harbour","America/Cordoba","America/Costa_Rica","America/Creston","America/Cuiaba","America/Curacao","America/Danmarkshavn","America/Dawson","America/Dawson_Creek","America/Denver","America/Detroit","America/Dominica","America/Edmonton","America/Eirunepe","America/El_Salvador","America/Ensenada","America/Fort_Nelson","America/Fort_Wayne","America/Fortaleza","America/Glace_Bay","America/Godthab","America/Goose_Bay","America/Grand_Turk","America/Grenada","America/Guadeloupe","America/Guatemala","America/Guayaquil","America/Guyana","America/Halifax","America/Havana","America/Hermosillo","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Tell_City","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Indianapolis","America/Inuvik","America/Iqaluit","America/Jamaica","America/Jujuy","America/Juneau","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Kralendijk","America/La_Paz","America/Lima","America/Los_Angeles","America/Louisville","America/Lower_Princes","America/Maceio","America/Managua","America/Manaus","America/Marigot","America/Martinique","America/Matamoros","America/Mazatlan","America/Mendoza","America/Menominee","America/Merida","America/Metlakatla","America/Mexico_City","America/Miquelon","America/Moncton","America/Monterrey","America/Montevideo","America/Montreal","America/Montserrat","America/Nassau","America/New_York","America/Nipigon","America/Nome","America/Noronha","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","America/Nuuk","America/Ojinaga","America/Panama","America/Pangnirtung","America/Paramaribo","America/Phoenix","America/Port-au-Prince","America/Port_of_Spain","America/Porto_Acre","America/Porto_Velho","America/Puerto_Rico","America/Punta_Arenas","America/Rainy_River","America/Rankin_Inlet","America/Recife","America/Regina","America/Resolute","America/Rio_Branco","America/Rosario","America/Santa_Isabel","America/Santarem","America/Santiago","America/Santo_Domingo","America/Sao_Paulo","America/Scoresbysund","America/Shiprock","America/Sitka","America/St_Barthelemy","America/St_Johns","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Swift_Current","America/Tegucigalpa","America/Thule","America/Thunder_Bay","America/Tijuana","America/Toronto","America/Tortola","America/Vancouver","America/Virgin","America/Whitehorse","America/Winnipeg","America/Yakutat","America/Yellowknife","Antarctica/Casey","Antarctica/Davis","Antarctica/DumontDUrville","Antarctica/Macquarie","Antarctica/Mawson","Antarctica/McMurdo","Antarctica/Palmer","Antarctica/Rothera","Antarctica/South_Pole","Antarctica/Syowa","Antarctica/Troll","Antarctica/Vostok","Arctic/Longyearbyen","Asia/Aden","Asia/Almaty","Asia/Amman","Asia/Anadyr","Asia/Aqtau","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Atyrau","Asia/Baghdad","Asia/Bahrain","Asia/Baku","Asia/Bangkok","Asia/Barnaul","Asia/Beirut","Asia/Bishkek","Asia/Brunei","Asia/Calcutta","Asia/Chita","Asia/Choibalsan","Asia/Chongqing","Asia/Chungking","Asia/Colombo","Asia/Dacca","Asia/Damascus","Asia/Dhaka","Asia/Dili","Asia/Dubai","Asia/Dushanbe","Asia/Famagusta","Asia/Gaza","Asia/Harbin","Asia/Hebron","Asia/Ho_Chi_Minh","Asia/Hong_Kong","Asia/Hovd","Asia/Irkutsk","Asia/Istanbul","Asia/Jakarta","Asia/Jayapura","Asia/Jerusalem","Asia/Kabul","Asia/Kamchatka","Asia/Karachi","Asia/Kashgar","Asia/Kathmandu","Asia/Katmandu","Asia/Khandyga","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Kuwait","Asia/Macao","Asia/Macau","Asia/Magadan","Asia/Makassar","Asia/Manila","Asia/Muscat","Asia/Nicosia","Asia/Novokuznetsk","Asia/Novosibirsk","Asia/Omsk","Asia/Oral","Asia/Phnom_Penh","Asia/Pontianak","Asia/Pyongyang","Asia/Qatar","Asia/Qostanay","Asia/Qyzylorda","Asia/Rangoon","Asia/Riyadh","Asia/Saigon","Asia/Sakhalin","Asia/Samarkand","Asia/Seoul","Asia/Shanghai","Asia/Singapore","Asia/Srednekolymsk","Asia/Taipei","Asia/Tashkent","Asia/Tbilisi","Asia/Tehran","Asia/Tel_Aviv","Asia/Thimbu","Asia/Thimphu","Asia/Tokyo","Asia/Tomsk","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Asia/Ust-Nera","Asia/Vientiane","Asia/Vladivostok","Asia/Yakutsk","Asia/Yangon","Asia/Yekaterinburg","Asia/Yerevan","Atlantic/Azores","Atlantic/Bermuda","Atlantic/Canary","Atlantic/Cape_Verde","Atlantic/Faeroe","Atlantic/Faroe","Atlantic/Jan_Mayen","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/South_Georgia","Atlantic/St_Helena","Atlantic/Stanley","Australia/ACT","Australia/Adelaide","Australia/Brisbane","Australia/Broken_Hill","Australia/Canberra","Australia/Currie","Australia/Darwin","Australia/Eucla","Australia/Hobart","Australia/LHI","Australia/Lindeman","Australia/Lord_Howe","Australia/Melbourne","Australia/NSW","Australia/North","Australia/Perth","Australia/Queensland","Australia/South","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Australia/West","Australia/Yancowinna","Brazil/Acre","Brazil/DeNoronha","Brazil/East","Brazil/West","CET","CST6CDT","Canada/Atlantic","Canada/Central","Canada/Eastern","Canada/Mountain","Canada/Newfoundland","Canada/Pacific","Canada/Saskatchewan","Canada/Yukon","Chile/Continental","Chile/EasterIsland","Cuba","EET","EST","EST5EDT","Egypt","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT+1","Etc/GMT+10","Etc/GMT+11","Etc/GMT+12","Etc/GMT+2","Etc/GMT+3","Etc/GMT+4","Etc/GMT+5","Etc/GMT+6","Etc/GMT+7","Etc/GMT+8","Etc/GMT+9","Etc/GMT-0","Etc/GMT-1","Etc/GMT-10","Etc/GMT-11","Etc/GMT-12","Etc/GMT-13","Etc/GMT-14","Etc/GMT-2","Etc/GMT-3","Etc/GMT-4","Etc/GMT-5","Etc/GMT-6","Etc/GMT-7","Etc/GMT-8","Etc/GMT-9","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Amsterdam","Europe/Andorra","Europe/Astrakhan","Europe/Athens","Europe/Belfast","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Bucharest","Europe/Budapest","Europe/Busingen","Europe/Chisinau","Europe/Copenhagen","Europe/Dublin","Europe/Gibraltar","Europe/Guernsey","Europe/Helsinki","Europe/Isle_of_Man","Europe/Istanbul","Europe/Jersey","Europe/Kaliningrad","Europe/Kiev","Europe/Kirov","Europe/Lisbon","Europe/Ljubljana","Europe/London","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Mariehamn","Europe/Minsk","Europe/Monaco","Europe/Moscow","Europe/Nicosia","Europe/Oslo","Europe/Paris","Europe/Podgorica","Europe/Prague","Europe/Riga","Europe/Rome","Europe/Samara","Europe/San_Marino","Europe/Sarajevo","Europe/Saratov","Europe/Simferopol","Europe/Skopje","Europe/Sofia","Europe/Stockholm","Europe/Tallinn","Europe/Tirane","Europe/Tiraspol","Europe/Ulyanovsk","Europe/Uzhgorod","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Vilnius","Europe/Volgograd","Europe/Warsaw","Europe/Zagreb","Europe/Zaporozhye","Europe/Zurich","GB","GB-Eire","GMT","GMT+0","GMT-0","GMT0","Greenwich","HST","Hongkong","Iceland","Indian/Antananarivo","Indian/Chagos","Indian/Christmas","Indian/Cocos","Indian/Comoro","Indian/Kerguelen","Indian/Mahe","Indian/Maldives","Indian/Mauritius","Indian/Mayotte","Indian/Reunion","Iran","Israel","Jamaica","Japan","Kwajalein","Libya","MET","MST","MST7MDT","Mexico/BajaNorte","Mexico/BajaSur","Mexico/General","NZ","NZ-CHAT","Navajo","PRC","PST8PDT","Pacific/Apia","Pacific/Auckland","Pacific/Bougainville","Pacific/Chatham","Pacific/Chuuk","Pacific/Easter","Pacific/Efate","Pacific/Enderbury","Pacific/Fakaofo","Pacific/Fiji","Pacific/Funafuti","Pacific/Galapagos","Pacific/Gambier","Pacific/Guadalcanal","Pacific/Guam","Pacific/Honolulu","Pacific/Johnston","Pacific/Kanton","Pacific/Kiritimati","Pacific/Kosrae","Pacific/Kwajalein","Pacific/Majuro","Pacific/Marquesas","Pacific/Midway","Pacific/Nauru","Pacific/Niue","Pacific/Norfolk","Pacific/Noumea","Pacific/Pago_Pago","Pacific/Palau","Pacific/Pitcairn","Pacific/Pohnpei","Pacific/Ponape","Pacific/Port_Moresby","Pacific/Rarotonga","Pacific/Saipan","Pacific/Samoa","Pacific/Tahiti","Pacific/Tarawa","Pacific/Tongatapu","Pacific/Truk","Pacific/Wake","Pacific/Wallis","Pacific/Yap","Poland","Portugal","ROC","ROK","Singapore","Turkey","UCT","US/Alaska","US/Aleutian","US/Arizona","US/Central","US/East-Indiana","US/Eastern","US/Hawaii","US/Indiana-Starke","US/Michigan","US/Mountain","US/Pacific","US/Samoa","UTC","Universal","W-SU","WET","Zulu"],"type":"string"},"type":{"description":"The report schedule type","enum":["Alert","Report"],"type":"string"},"validator_config_json":{"$ref":"#/components/schemas/ValidatorConfigJSON"},"validator_type":{"description":"Determines when to trigger alert based off value from alert query. Alerts will be triggered with these validator types:\\n- Not Null - When the return value is Not NULL, Empty, or 0\\n- Operator - When `sql_return_value comparison_operator threshold` is True e.g. `50 <= 75`<br>Supports the comparison operators <, <=, >, >=, ==, and !=","enum":["not null","operator"],"nullable":true,"type":"string"},"working_timeout":{"description":"If an alert is staled at a working state, how long until it\'s state is reseted to error","example":3600,"minimum":1,"nullable":true,"type":"integer"}},"type":"object"},"Resource":{"properties":{"id":{"type":"string"},"type":{"enum":["dashboard"]}},"required":["id","type"],"type":"object"},"RlsRule":{"properties":{"clause":{"type":"string"},"dataset":{"type":"integer"}},"required":["clause"],"type":"object"},"Roles":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"Roles1":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"SavedQueryRestApi.get":{"properties":{"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/SavedQueryRestApi.get.User"},"database":{"$ref":"#/components/schemas/SavedQueryRestApi.get.Database"},"description":{"nullable":true,"type":"string"},"id":{"type":"integer"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_tables":{"readOnly":true},"template_parameters":{"nullable":true,"type":"string"}},"type":"object"},"SavedQueryRestApi.get.Database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object"},"SavedQueryRestApi.get.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"SavedQueryRestApi.get_list":{"properties":{"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/SavedQueryRestApi.get_list.User"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"database":{"$ref":"#/components/schemas/SavedQueryRestApi.get_list.Database"},"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"extra":{"readOnly":true},"id":{"type":"integer"},"label":{"maxLength":256,"nullable":true,"type":"string"},"last_run_delta_humanized":{"readOnly":true},"rows":{"nullable":true,"type":"integer"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"sql_tables":{"readOnly":true},"tags":{"$ref":"#/components/schemas/SavedQueryRestApi.get_list.Tag"}},"type":"object"},"SavedQueryRestApi.get_list.Database":{"properties":{"database_name":{"maxLength":250,"type":"string"},"id":{"type":"integer"}},"required":["database_name"],"type":"object"},"SavedQueryRestApi.get_list.Tag":{"properties":{"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"SavedQueryRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"SavedQueryRestApi.post":{"properties":{"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"template_parameters":{"nullable":true,"type":"string"}},"type":"object"},"SavedQueryRestApi.put":{"properties":{"db_id":{"nullable":true,"type":"integer"},"description":{"nullable":true,"type":"string"},"label":{"maxLength":256,"nullable":true,"type":"string"},"schema":{"maxLength":128,"nullable":true,"type":"string"},"sql":{"nullable":true,"type":"string"},"template_parameters":{"nullable":true,"type":"string"}},"type":"object"},"SchemasResponseSchema":{"properties":{"result":{"items":{"description":"A database schema name","type":"string"},"type":"array"}},"type":"object"},"SelectStarResponseSchema":{"properties":{"result":{"description":"SQL select star","type":"string"}},"type":"object"},"Slice":{"properties":{"cache_timeout":{"description":"Duration (in seconds) of the caching timeout for this chart.","type":"integer"},"certification_details":{"description":"Details of the certification.","type":"string"},"certified_by":{"description":"Person or group that has certified this dashboard.","type":"string"},"changed_on":{"description":"Timestamp of the last modification.","format":"date-time","type":"string"},"changed_on_humanized":{"description":"Timestamp of the last modification in human readable form.","type":"string"},"datasource":{"description":"Datasource identifier.","type":"string"},"description":{"description":"Slice description.","type":"string"},"description_markeddown":{"description":"Sanitized HTML version of the chart description.","type":"string"},"edit_url":{"description":"The URL for editing the slice.","type":"string"},"form_data":{"description":"Form data associated with the slice.","type":"object"},"is_managed_externally":{"description":"If the chart is managed outside externally.","type":"boolean"},"modified":{"description":"Last modification in human readable form.","type":"string"},"owners":{"description":"Owners identifiers.","items":{"type":"integer"},"type":"array"},"query_context":{"description":"The context associated with the query.","type":"object"},"slice_id":{"description":"The slice ID.","type":"integer"},"slice_name":{"description":"The slice name.","type":"string"},"slice_url":{"description":"The slice URL.","type":"string"}},"type":"object"},"StopQuerySchema":{"properties":{"client_id":{"type":"string"}},"type":"object"},"TableExtraMetadataResponseSchema":{"properties":{"clustering":{"type":"object"},"metadata":{"type":"object"},"partitions":{"type":"object"}},"type":"object"},"TableMetadataColumnsResponse":{"properties":{"duplicates_constraint":{"type":"string"},"keys":{"description":"","items":{"type":"string"},"type":"array"},"longType":{"description":"The actual backend long type for the column","type":"string"},"name":{"description":"The column name","type":"string"},"type":{"description":"The column type","type":"string"}},"type":"object"},"TableMetadataForeignKeysIndexesResponse":{"properties":{"column_names":{"items":{"description":"A list of column names that compose the foreign key or index","type":"string"},"type":"array"},"name":{"description":"The name of the foreign key or index","type":"string"},"options":{"$ref":"#/components/schemas/TableMetadataOptionsResponse"},"referred_columns":{"items":{"type":"string"},"type":"array"},"referred_schema":{"type":"string"},"referred_table":{"type":"string"},"type":{"type":"string"}},"type":"object"},"TableMetadataOptionsResponse":{"properties":{"deferrable":{"type":"boolean"},"initially":{"type":"boolean"},"match":{"type":"boolean"},"ondelete":{"type":"boolean"},"onupdate":{"type":"boolean"}},"type":"object"},"TableMetadataPrimaryKeyResponse":{"properties":{"column_names":{"items":{"description":"A list of column names that compose the primary key","type":"string"},"type":"array"},"name":{"description":"The primary key index name","type":"string"},"type":{"type":"string"}},"type":"object"},"TableMetadataResponseSchema":{"properties":{"columns":{"description":"A list of columns and their metadata","items":{"$ref":"#/components/schemas/TableMetadataColumnsResponse"},"type":"array"},"foreignKeys":{"description":"A list of foreign keys and their metadata","items":{"$ref":"#/components/schemas/TableMetadataForeignKeysIndexesResponse"},"type":"array"},"indexes":{"description":"A list of indexes and their metadata","items":{"$ref":"#/components/schemas/TableMetadataForeignKeysIndexesResponse"},"type":"array"},"name":{"description":"The name of the table","type":"string"},"primaryKey":{"allOf":[{"$ref":"#/components/schemas/TableMetadataPrimaryKeyResponse"}],"description":"Primary keys metadata"},"selectStar":{"description":"SQL select star","type":"string"}},"type":"object"},"Tables":{"properties":{"id":{"type":"integer"},"schema":{"type":"string"},"table_name":{"type":"string"}},"type":"object"},"Tag":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"Tag1":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"TagGetResponseSchema":{"properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"}},"type":"object"},"TagRestApi.get":{"properties":{"changed_by":{"$ref":"#/components/schemas/TagRestApi.get.User1"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/TagRestApi.get.User"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"TagRestApi.get.User":{"properties":{"active":{"nullable":true,"type":"boolean"},"changed_on":{"format":"date-time","nullable":true,"type":"string"},"created_on":{"format":"date-time","nullable":true,"type":"string"},"email":{"maxLength":64,"type":"string"},"fail_login_count":{"nullable":true,"type":"integer"},"first_name":{"maxLength":64,"type":"string"},"id":{"type":"integer"},"last_login":{"format":"date-time","nullable":true,"type":"string"},"last_name":{"maxLength":64,"type":"string"},"login_count":{"nullable":true,"type":"integer"},"password":{"maxLength":256,"nullable":true,"type":"string"},"username":{"maxLength":64,"type":"string"}},"required":["email","first_name","last_name","username"],"type":"object"},"TagRestApi.get.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"TagRestApi.get_list":{"properties":{"changed_by":{"$ref":"#/components/schemas/TagRestApi.get_list.User1"},"changed_on_delta_humanized":{"readOnly":true},"created_by":{"$ref":"#/components/schemas/TagRestApi.get_list.User"},"id":{"type":"integer"},"name":{"maxLength":250,"nullable":true,"type":"string"},"type":{"enum":[1,2,3,4]}},"type":"object"},"TagRestApi.get_list.User":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"TagRestApi.get_list.User1":{"properties":{"first_name":{"maxLength":64,"type":"string"},"last_name":{"maxLength":64,"type":"string"}},"required":["first_name","last_name"],"type":"object"},"TagRestApi.post":{"properties":{"tags":{"items":{"type":"string"},"type":"array"}},"type":"object"},"TagRestApi.put":{"properties":{"id":{"type":"integer"}},"type":"object"},"TaggedObjectEntityResponseSchema":{"properties":{"changed_on":{"format":"date-time","type":"string"},"created_by":{"$ref":"#/components/schemas/User"},"creator":{"type":"string"},"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"},"url":{"type":"string"}},"type":"object"},"TemporaryCachePostSchema":{"properties":{"value":{"description":"Any type of JSON supported text.","type":"string"}},"required":["value"],"type":"object"},"TemporaryCachePutSchema":{"properties":{"value":{"description":"Any type of JSON supported text.","type":"string"}},"required":["value"],"type":"object"},"User":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"}},"type":"object"},"User1":{"properties":{"first_name":{"type":"string"},"id":{"type":"integer"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object"},"User2":{"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object"},"UserResponseSchema":{"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"id":{"type":"integer"},"is_active":{"type":"boolean"},"is_anonymous":{"type":"boolean"},"last_name":{"type":"string"},"username":{"type":"string"}},"type":"object"},"ValidateSQLRequest":{"properties":{"schema":{"nullable":true,"type":"string"},"sql":{"description":"SQL statement to validate","type":"string"},"template_params":{"nullable":true,"type":"object"}},"required":["sql"],"type":"object"},"ValidateSQLResponse":{"properties":{"end_column":{"type":"integer"},"line_number":{"type":"integer"},"message":{"type":"string"},"start_column":{"type":"integer"}},"type":"object"},"ValidatorConfigJSON":{"properties":{"op":{"description":"The operation to compare with a threshold to apply to the SQL output\\n","enum":["<","<=",">",">=","==","!="],"type":"string"},"threshold":{"type":"number"}},"type":"object"},"advanced_data_type_convert_schema":{"properties":{"type":{"default":"port","type":"string"},"values":{"items":{"default":"http"},"minItems":1,"type":"array"}},"required":["type","values"],"type":"object"},"database_schemas_query_schema":{"properties":{"force":{"type":"boolean"}},"type":"object"},"database_tables_query_schema":{"properties":{"force":{"type":"boolean"},"schema_name":{"type":"string"}},"required":["schema_name"],"type":"object"},"delete_tags_schema":{"items":{"type":"string"},"type":"array"},"get_delete_ids_schema":{"items":{"type":"integer"},"type":"array"},"get_export_ids_schema":{"items":{"type":"integer"},"type":"array"},"get_fav_star_ids_schema":{"items":{"type":"integer"},"type":"array"},"get_info_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"},"get_item_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"},"get_list_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"},{"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"}},"type":"object"},"get_recent_activity_schema":{"properties":{"actions":{"items":{"type":"string"},"type":"array"},"distinct":{"type":"boolean"},"page":{"type":"number"},"page_size":{"type":"number"}},"type":"object"},"get_related_schema":{"properties":{"filter":{"type":"string"},"include_ids":{"items":{"type":"integer"},"type":"array"},"page":{"type":"integer"},"page_size":{"type":"integer"}},"type":"object"},"queries_get_updated_since_schema":{"properties":{"last_updated_ms":{"type":"number"}},"required":["last_updated_ms"],"type":"object"},"screenshot_query_schema":{"properties":{"force":{"type":"boolean"},"thumb_size":{"items":{"type":"integer"},"type":"array"},"window_size":{"items":{"type":"integer"},"type":"array"}},"type":"object"},"sql_lab_get_results_schema":{"properties":{"key":{"type":"string"}},"required":["key"],"type":"object"},"thumbnail_query_schema":{"properties":{"force":{"type":"boolean"}},"type":"object"}},"securitySchemes":{"jwt":{"bearerFormat":"JWT","scheme":"bearer","type":"http"},"jwt_refresh":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"info":{"description":"Superset","title":"Superset","version":"v1"},"openapi":"3.0.2","paths":{"/api/v1/advanced_data_type/convert":{"get":{"parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/advanced_data_type_convert_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdvancedDataTypeSchema"}}},"description":"AdvancedDataTypeResponse object has been returned."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Returns a AdvancedDataTypeResponse object populated with the passed in args.","tags":["Advanced Data Type"]}},"/api/v1/advanced_data_type/types":{"get":{"description":"Returns a list of available advanced data types.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"type":"string"},"type":"array"}},"type":"object"}}},"description":"a successful return of the available advanced data types has taken place."},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Advanced Data Type"]}},"/api/v1/annotation_layer/":{"delete":{"description":"Deletes multiple annotation layers in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"CSS templates bulk delete"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"get":{"description":"Get a list of Annotation layers, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/AnnotationLayerRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"post":{"description":"Create an Annotation layer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationLayerRestApi.post"}}},"description":"Annotation Layer schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/AnnotationLayerRestApi.post"}},"type":"object"}}},"description":"Annotation added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]}},"/api/v1/annotation_layer/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]}},"/api/v1/annotation_layer/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]}},"/api/v1/annotation_layer/{pk}":{"delete":{"description":"Delete Annotation layer","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"get":{"description":"Get an Annotation layer","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/AnnotationLayerRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"put":{"description":"Update an Annotation layer","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationLayerRestApi.put"}}},"description":"Annotation schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/AnnotationLayerRestApi.put"}},"type":"object"}}},"description":"Annotation changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]}},"/api/v1/annotation_layer/{pk}/annotation/":{"delete":{"description":"Deletes multiple annotation in a bulk operation.","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Annotations bulk delete"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"get":{"description":"Get a list of Annotation layers, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"description":"The annotation layer id for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"ids":{"description":"A list of annotation ids","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"$ref":"#/components/schemas/AnnotationRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Annotations"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"post":{"description":"Create an Annotation layer","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationRestApi.post"}}},"description":"Annotation schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/AnnotationRestApi.post"}},"type":"object"}}},"description":"Annotation added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]}},"/api/v1/annotation_layer/{pk}/annotation/{annotation_id}":{"delete":{"description":"Delete Annotation layer","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The annotation pk for this annotation","in":"path","name":"annotation_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"get":{"description":"Get an Annotation layer","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The annotation pk","in":"path","name":"annotation_id","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"The item id","type":"string"},"result":{"$ref":"#/components/schemas/AnnotationRestApi.get"}},"type":"object"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]},"put":{"description":"Update an Annotation layer","parameters":[{"description":"The annotation layer pk for this annotation","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The annotation pk for this annotation","in":"path","name":"annotation_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationRestApi.put"}}},"description":"Annotation schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/AnnotationRestApi.put"}},"type":"object"}}},"description":"Annotation changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Annotation Layers"]}},"/api/v1/assets/export/":{"get":{"description":"Returns a ZIP file with all the Superset assets (databases, datasets, charts, dashboards, saved queries) as YAML files.","responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"ZIP file"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Import/export"]}},"/api/v1/assets/import/":{"post":{"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"bundle":{"description":"upload file (ZIP or JSON)","format":"binary","type":"string"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key_password\\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key\\"}`.","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Assets import result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Import/export"]}},"/api/v1/async_event/":{"get":{"description":"Reads off of the Redis events stream, using the user\'s JWT token and optional query params for last event received.","parameters":[{"description":"Last ID received by the client","in":"query","name":"last_id","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"properties":{"channel_id":{"type":"string"},"errors":{"items":{"type":"object"},"type":"array"},"id":{"type":"string"},"job_id":{"type":"string"},"result_url":{"type":"string"},"status":{"type":"string"},"user_id":{"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Async event results"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["AsyncEventsRestApi"]}},"/api/v1/available_domains/":{"get":{"description":"Get all available domains","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/AvailableDomainsSchema"}},"type":"object"}}},"description":"a list of available domains"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"}},"security":[{"jwt":[]}],"tags":["Available Domains"]}},"/api/v1/cachekey/invalidate":{"post":{"description":"Takes a list of datasources, finds the associated cache records and invalidates them and removes the database records","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CacheInvalidationRequestSchema"}}},"description":"A list of datasources uuid or the tuples of database and datasource names","required":true},"responses":{"201":{"description":"cache was successfully invalidated"},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CacheRestApi"]}},"/api/v1/chart/":{"delete":{"description":"Deletes multiple Charts in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Charts bulk delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]},"get":{"description":"Get a list of charts, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/ChartRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]},"post":{"description":"Create a new Chart.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartRestApi.post"}}},"description":"Chart schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/ChartRestApi.post"}},"type":"object"}}},"description":"Chart added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/_info":{"get":{"description":"Several metadata information about chart API endpoints.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/data":{"post":{"description":"Takes a query context constructed in the client and returns payload data response for the given query.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartDataQueryContextSchema"}}},"description":"A query context consists of a datasource from which to fetch data and one or many query objects.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartDataResponseSchema"}}},"description":"Query result"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartDataAsyncResponseSchema"}}},"description":"Async job details"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/data/{cache_key}":{"get":{"description":"Takes a query context cache key and returns payload data response for the given query.","parameters":[{"in":"path","name":"cache_key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartDataResponseSchema"}}},"description":"Query result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/export/":{"get":{"description":"Exports multiple charts and downloads them as YAML files","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_export_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"A zip file with chart(s), dataset(s) and database(s) as YAML"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/favorite_status/":{"get":{"description":"Check favorited dashboards for current user","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_fav_star_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFavStarIdsSchema"}}},"description":"None"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/import/":{"post":{"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing charts?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key_password\\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key\\"}`.","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Chart import result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/related/{column_name}":{"get":{"description":"Get a list of all possible owners for a chart. Use `owners` has the `column_name` parameter","parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/warm_up_cache":{"put":{"description":"Warms up the cache for the chart. Note for slices a force refresh occurs. In terms of the `extra_filters` these can be obtained from records in the JSON encoded `logs.json` column associated with the `explore_json` action.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartCacheWarmUpRequestSchema"}}},"description":"Identifies the chart to warm up cache for, and any additional dashboard or filter context to use.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartCacheWarmUpResponseSchema"}}},"description":"Each chart\'s warmup status"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Warms up the cache for the chart","tags":["Charts"]}},"/api/v1/chart/{pk}":{"delete":{"description":"Deletes a Chart.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Chart delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]},"get":{"description":"Get a chart detail information.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/ChartRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]},"put":{"description":"Changes a Chart.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartRestApi.put"}}},"description":"Chart schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/ChartRestApi.put"}},"type":"object"}}},"description":"Chart changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/{pk}/cache_screenshot/":{"get":{"description":"Compute and cache a screenshot.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/screenshot_query_schema"}}},"in":"query","name":"q"}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartCacheScreenshotResponseSchema"}}},"description":"Chart async result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/{pk}/data/":{"get":{"description":"Takes a chart ID and uses the query context stored when the chart was saved to return payload data response.","parameters":[{"description":"The chart ID","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The format in which the data should be returned","in":"query","name":"format","schema":{"type":"string"}},{"description":"The type in which the data should be returned","in":"query","name":"type","schema":{"type":"string"}},{"description":"Should the queries be forced to load from the source","in":"query","name":"force","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartDataResponseSchema"}}},"description":"Query result"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChartDataAsyncResponseSchema"}}},"description":"Async job details"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/{pk}/favorites/":{"delete":{"description":"Remove the chart from the user favorite list","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Chart removed from favorites"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]},"post":{"description":"Marks the chart as favorite for the current user","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Chart added to favorites"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/{pk}/screenshot/{digest}/":{"get":{"description":"Get a computed screenshot from cache.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"digest","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Chart thumbnail image"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/chart/{pk}/thumbnail/{digest}/":{"get":{"description":"Compute or get already computed chart thumbnail from cache.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"digest","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Chart thumbnail image"},"302":{"description":"Redirects to the current digest"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Charts"]}},"/api/v1/css_template/":{"delete":{"description":"Deletes multiple css templates in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"CSS templates bulk delete"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]},"get":{"description":"Get a list of CSS templates, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/CssTemplateRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]},"post":{"description":"Create a CSS template","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CssTemplateRestApi.post"}}},"description":"Model schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"$ref":"#/components/schemas/CssTemplateRestApi.post"}},"type":"object"}}},"description":"Item inserted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]}},"/api/v1/css_template/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]}},"/api/v1/css_template/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]}},"/api/v1/css_template/{pk}":{"delete":{"description":"Delete CSS template","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]},"get":{"description":"Get a CSS template","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/CssTemplateRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]},"put":{"description":"Update a CSS template","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CssTemplateRestApi.put"}}},"description":"Model schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/CssTemplateRestApi.put"}},"type":"object"}}},"description":"Item changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["CSS Templates"]}},"/api/v1/dashboard/":{"delete":{"description":"Deletes multiple Dashboards in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dashboard bulk delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"get":{"description":"Get a list of dashboards, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/DashboardRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"post":{"description":"Create a new Dashboard.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardRestApi.post"}}},"description":"Dashboard schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/DashboardRestApi.post"}},"type":"object"}}},"description":"Dashboard added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/_info":{"get":{"description":"Several metadata information about dashboard API endpoints.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/export/":{"get":{"description":"Exports multiple Dashboards and downloads them as YAML files.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_export_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Dashboard export"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/favorite_status/":{"get":{"description":"Check favorited dashboards for current user","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_fav_star_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFavStarIdsSchema"}}},"description":"None"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/import/":{"post":{"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP or JSON)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing dashboards?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key_password\\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key\\"}`.","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dashboard import result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/permalink/{key}":{"get":{"description":"Retrives dashboard state associated with a permanent link.","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"state":{"description":"The stored state","type":"object"}},"type":"object"}}},"description":"Returns the stored state."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboard Permanent Link"]}},"/api/v1/dashboard/related/{column_name}":{"get":{"description":"Get a list of all possible owners for a dashboard.","parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{dashboard_id}/filtersets":{"get":{"description":"Get a dashboard\'s list of filter sets","parameters":[{"description":"The id of the dashboard","in":"path","name":"dashboard_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"description":{"description":"A description field of the filter set","type":"string"},"json_metadata":{"description":"metadata of the filter set","type":"string"},"name":{"description":"Name of the Filter set","type":"string"},"owner_id":{"description":"A description field of the filter set","type":"integer"},"owner_type":{"description":"the Type of the owner ( Dashboard/User)","type":"integer"},"parameters":{"description":"JSON schema defining the needed parameters"}},"type":"object"},"type":"array"}}},"description":"FilterSets"},"302":{"description":"Redirects to the current digest"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"}},"security":[{"jwt":[]}],"tags":["FilterSetRestApi"]},"post":{"description":"Create a new Dashboard\'s Filter Set.","parameters":[{"description":"The id of the dashboard","in":"path","name":"dashboard_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterSetRestApi.post"}}},"description":"Filter set schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/FilterSetRestApi.post"}},"type":"object"}}},"description":"Filter set added"},"302":{"description":"Redirects to the current digest"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["FilterSetRestApi"]}},"/api/v1/dashboard/{dashboard_id}/filtersets/{pk}":{"delete":{"description":"Deletes a Dashboard.","parameters":[{"in":"path","name":"dashboard_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Filter set deleted"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["FilterSetRestApi"]},"put":{"description":"Changes a Dashboard\'s Filter set.","parameters":[{"in":"path","name":"dashboard_id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilterSetRestApi.put"}}},"description":"Filter set schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/FilterSetRestApi.put"}},"type":"object"}}},"description":"Filter set changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["FilterSetRestApi"]}},"/api/v1/dashboard/{id_or_slug}":{"get":{"description":"Get a dashboard detail information.","parameters":[{"description":"Either the id of the dashboard, or its slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/DashboardGetResponseSchema"}},"type":"object"}}},"description":"Dashboard"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{id_or_slug}/charts":{"get":{"description":"Get the chart definitions for a given dashboard","parameters":[{"in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"$ref":"#/components/schemas/ChartEntityResponseSchema"},"type":"array"}},"type":"object"}}},"description":"Dashboard chart definitions"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{id_or_slug}/copy/":{"post":{"parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardCopySchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"last_modified_time":{"type":"number"}},"type":"object"}}},"description":"Id of new dashboard and last modified time"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Makes a copy of an existing dashboard","tags":["Dashboards"]}},"/api/v1/dashboard/{id_or_slug}/datasets":{"get":{"description":"Returns a list of a dashboard\'s datasets. Each dataset includes only the information necessary to render the dashboard\'s charts.","parameters":[{"description":"Either the id of the dashboard, or its slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"$ref":"#/components/schemas/DashboardDatasetSchema"},"type":"array"}},"type":"object"}}},"description":"Dashboard dataset definitions"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{id_or_slug}/embedded":{"delete":{"description":"Removes a dashboard\'s embedded configuration.","parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Successfully removed the configuration"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"get":{"description":"Returns the dashboard\'s embedded configuration","parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/EmbeddedDashboardResponseSchema"}},"type":"object"}}},"description":"Result contains the embedded dashboard config"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"post":{"description":"Sets a dashboard\'s embedded configuration.","parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedDashboardConfig"}}},"description":"The embedded configuration to set","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/EmbeddedDashboardResponseSchema"}},"type":"object"}}},"description":"Successfully set the configuration"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"put":{"description":"Sets a dashboard\'s embedded configuration.","parameters":[{"description":"The dashboard id or slug","in":"path","name":"id_or_slug","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddedDashboardConfig"}}},"description":"The embedded configuration to set","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/EmbeddedDashboardResponseSchema"}},"type":"object"}}},"description":"Successfully set the configuration"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{pk}":{"delete":{"description":"Deletes a Dashboard.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dashboard deleted"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"put":{"description":"Changes a Dashboard.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardRestApi.put"}}},"description":"Dashboard schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"last_modified_time":{"type":"number"},"result":{"$ref":"#/components/schemas/DashboardRestApi.put"}},"type":"object"}}},"description":"Dashboard changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{pk}/favorites/":{"delete":{"description":"Remove the dashboard from the user favorite list","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Dashboard removed from favorites"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]},"post":{"description":"Marks the dashboard as favorite for the current user","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Dashboard added to favorites"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/dashboard/{pk}/filter_state":{"post":{"description":"Stores a new value.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryCachePostSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the value.","type":"string"}},"type":"object"}}},"description":"The value was stored successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboard Filter State"]}},"/api/v1/dashboard/{pk}/filter_state/{key}":{"delete":{"description":"Deletes a value.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The value key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"description":"The result of the operation","type":"string"}},"type":"object"}}},"description":"Deleted the stored value."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboard Filter State"]},"get":{"description":"Retrives a value.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"value":{"description":"The stored value","type":"string"}},"type":"object"}}},"description":"Returns the stored value."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboard Filter State"]},"put":{"description":"Updates an existing value.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"path","name":"key","required":true,"schema":{"type":"string"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryCachePutSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the value.","type":"string"}},"type":"object"}}},"description":"The value was stored successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboard Filter State"]}},"/api/v1/dashboard/{pk}/permalink":{"post":{"description":"Stores a new permanent link.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardPermalinkStateSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the permanent link data.","type":"string"},"url":{"description":"permanent link.","type":"string"}},"type":"object"}}},"description":"The permanent link was stored successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboard Permanent Link"]}},"/api/v1/dashboard/{pk}/thumbnail/{digest}/":{"get":{"description":"Compute async or get already computed dashboard thumbnail from cache.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"A hex digest that makes this dashboard unique","in":"path","name":"digest","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/thumbnail_query_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"image/*":{"schema":{"format":"binary","type":"string"}}},"description":"Dashboard thumbnail image"},"202":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Thumbnail does not exist on cache, fired async to compute"},"302":{"description":"Redirects to the current digest"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Dashboards"]}},"/api/v1/database/":{"get":{"description":"Get a list of models","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/DatabaseRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]},"post":{"description":"Create a new Database.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseRestApi.post"}}},"description":"Database schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/DatabaseRestApi.post"}},"type":"object"}}},"description":"Database added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/available/":{"get":{"description":"Get names of databases currently available","responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"available_drivers":{"description":"Installed drivers for the engine","items":{"type":"string"},"type":"array"},"default_driver":{"description":"Default driver for the engine","type":"string"},"engine":{"description":"Name of the SQLAlchemy engine","type":"string"},"engine_information":{"description":"Dict with public properties form the DB Engine","properties":{"disable_ssh_tunneling":{"description":"Whether the engine supports SSH Tunnels","type":"boolean"},"supports_file_upload":{"description":"Whether the engine supports file uploads","type":"boolean"}},"type":"object"},"name":{"description":"Name of the database","type":"string"},"parameters":{"description":"JSON schema defining the needed parameters","type":"object"},"preferred":{"description":"Is the database preferred?","type":"boolean"},"sqlalchemy_uri_placeholder":{"description":"Example placeholder for the SQLAlchemy URI","type":"string"}},"type":"object"},"type":"array"}}},"description":"Database names"},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/export/":{"get":{"description":"Download database(s) and associated dataset(s) as a zip file","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_export_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"A zip file with database(s) and dataset(s) as YAML"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/import/":{"post":{"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing databases?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key_password\\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key\\"}`.","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Database import result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/test_connection/":{"post":{"description":"Tests a database connection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseTestConnectionSchema"}}},"description":"Database schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Database Test Connection"},"400":{"$ref":"#/components/responses/400"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/validate_parameters/":{"post":{"description":"Validates parameters used to connect to a database","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseValidateParametersSchema"}}},"description":"DB-specific parameters","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Database Test Connection"},"400":{"$ref":"#/components/responses/400"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}":{"delete":{"description":"Deletes a Database.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Database deleted"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]},"get":{"description":"Get a database","parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Database"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]},"put":{"description":"Changes a Database.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseRestApi.put"}}},"description":"Database schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/DatabaseRestApi.put"}},"type":"object"}}},"description":"Database changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/connection":{"get":{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseConnectionSchema"}}},"description":"Database with connection info"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Get a database connection info","tags":["Database"]}},"/api/v1/database/{pk}/function_names/":{"get":{"description":"Get function names supported by a database","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseFunctionNamesResponse"}}},"description":"Query result"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/related_objects/":{"get":{"description":"Get charts and dashboards count associated to a database","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseRelatedObjectsResponse"}}},"description":"Query result"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/schemas/":{"get":{"description":"Get all schemas from a database","parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/database_schemas_query_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemasResponseSchema"}}},"description":"A List of all schemas from the database"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/schemas_access_for_file_upload/":{"get":{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseSchemaAccessForFileUploadResponse"}}},"description":"The list of the database schemas where to upload information"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"The list of the database schemas where to upload information","tags":["Database"]}},"/api/v1/database/{pk}/select_star/{table_name}/":{"get":{"description":"Get database select star for table","parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"path","name":"table_name","required":true,"schema":{"type":"string"}},{"description":"Table schema","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectStarResponseSchema"}}},"description":"SQL statement for a select star for table"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/select_star/{table_name}/{schema_name}/":{"get":{"description":"Get database select star for table","parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"path","name":"table_name","required":true,"schema":{"type":"string"}},{"description":"Table schema","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectStarResponseSchema"}}},"description":"SQL statement for a select star for table"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/ssh_tunnel/":{"delete":{"description":"Deletes a SSH Tunnel.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"SSH Tunnel deleted"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/table/{table_name}/{schema_name}/":{"get":{"description":"Get database table metadata","parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"path","name":"table_name","required":true,"schema":{"type":"string"}},{"description":"Table schema","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableMetadataResponseSchema"}}},"description":"Table metadata information"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Database"]}},"/api/v1/database/{pk}/table_extra/{table_name}/{schema_name}/":{"get":{"description":"Response depends on each DB engine spec normally focused on partitions","parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"Table name","in":"path","name":"table_name","required":true,"schema":{"type":"string"}},{"description":"Table schema","in":"path","name":"schema_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableExtraMetadataResponseSchema"}}},"description":"Table extra metadata information"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Get table extra metadata","tags":["Database"]}},"/api/v1/database/{pk}/tables/":{"get":{"parameters":[{"description":"The database id","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/database_tables_query_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"type":"integer"},"result":{"description":"A List of tables for given database","items":{"$ref":"#/components/schemas/DatabaseTablesResponse"},"type":"array"}},"type":"object"}}},"description":"Tables list"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Get a list of tables for given database","tags":["Database"]}},"/api/v1/database/{pk}/validate_sql/":{"post":{"description":"Validates arbitrary SQL.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateSQLRequest"}}},"description":"Validate SQL request","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A List of SQL errors found on the statement","items":{"$ref":"#/components/schemas/ValidateSQLResponse"},"type":"array"}},"type":"object"}}},"description":"Validation result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Validates that arbitrary sql is acceptable for the given database","tags":["Database"]}},"/api/v1/dataset/":{"delete":{"description":"Deletes multiple Datasets in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dataset bulk delete"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]},"get":{"description":"Get a list of models","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/DatasetRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]},"post":{"description":"Create a new Dataset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetRestApi.post"}}},"description":"Dataset schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/DatasetRestApi.post"}},"type":"object"}}},"description":"Dataset added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/distinct/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistincResponseSchema"}}},"description":"Distinct field data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/duplicate":{"post":{"description":"Duplicates a Dataset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDuplicateSchema"}}},"description":"Dataset schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/DatasetDuplicateSchema"}},"type":"object"}}},"description":"Dataset duplicated"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/export/":{"get":{"description":"Exports multiple datasets and downloads them as YAML files","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_export_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Dataset export"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/get_or_create/":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrCreateDatasetSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"table_id":{"type":"integer"}},"type":"object"}},"type":"object"}}},"description":"The ID of the table"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Retrieve a table by name, or create it if it does not exist","tags":["Datasets"]}},"/api/v1/dataset/import/":{"post":{"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP or YAML)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing datasets?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key_password\\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key\\"}`.","type":"string"},"sync_columns":{"description":"sync columns?","type":"boolean"},"sync_metrics":{"description":"sync metrics?","type":"boolean"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dataset import result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/warm_up_cache":{"put":{"description":"Warms up the cache for the table. Note for slices a force refresh occurs. In terms of the `extra_filters` these can be obtained from records in the JSON encoded `logs.json` column associated with the `explore_json` action.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetCacheWarmUpRequestSchema"}}},"description":"Identifies the database and table to warm up cache for, and any additional dashboard or filter context to use.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetCacheWarmUpResponseSchema"}}},"description":"Each chart\'s warmup status"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Warms up the cache for each chart powered by the given table","tags":["Datasets"]}},"/api/v1/dataset/{pk}":{"delete":{"description":"Deletes a Dataset","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dataset delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]},"get":{"description":"Get an item model","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/DatasetRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]},"put":{"description":"Changes a Dataset","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"in":"query","name":"override_columns","schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetRestApi.put"}}},"description":"Dataset schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/DatasetRestApi.put"}},"type":"object"}}},"description":"Dataset changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/{pk}/column/{column_id}":{"delete":{"description":"Delete a Dataset column","parameters":[{"description":"The dataset pk for this column","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The column id for this dataset","in":"path","name":"column_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Column deleted"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/{pk}/metric/{metric_id}":{"delete":{"description":"Delete a Dataset metric","parameters":[{"description":"The dataset pk for this column","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The metric id for this dataset","in":"path","name":"metric_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Metric deleted"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/{pk}/refresh":{"put":{"description":"Refreshes and updates columns of a dataset","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Dataset delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/dataset/{pk}/related_objects":{"get":{"description":"Get charts and dashboards count associated to a dataset","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetRelatedObjectsResponse"}}},"description":"Query result"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Datasets"]}},"/api/v1/datasource/{datasource_type}/{datasource_id}/column/{column_name}/values/":{"get":{"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"}},{"description":"The name of the column to get values for","in":"path","name":"column_name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"object"}]},"type":"array"}},"type":"object"}}},"description":"A List of distinct values for the column"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Get possible values for a datasource column","tags":["Datasources"]}},"/api/v1/embedded_dashboard/{uuid}":{"get":{"description":"Get a report schedule log","parameters":[{"description":"The embedded configuration uuid","in":"path","name":"uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/EmbeddedDashboardResponseSchema"}},"type":"object"}}},"description":"Result contains the embedded dashboard configuration"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Embedded Dashboard"]}},"/api/v1/explore/":{"get":{"description":"Assembles Explore related information (form_data, slice, dataset)\\\\n in a single endpoint.<br/><br/>\\\\nThe information can be assembled from:<br/> - The cache using a form_data_key<br/> - The metadata database using a permalink_key<br/> - Build from scratch using dataset or slice identifiers.","parameters":[{"in":"query","name":"form_data_key","schema":{"type":"string"}},{"in":"query","name":"permalink_key","schema":{"type":"string"}},{"in":"query","name":"slice_id","schema":{"type":"integer"}},{"in":"query","name":"datasource_id","schema":{"type":"integer"}},{"in":"query","name":"datasource_type","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExploreContextSchema"}}},"description":"Returns the initial context."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Assembles Explore related information (form_data, slice, dataset)\\\\n in a single endpoint.","tags":["Explore"]}},"/api/v1/explore/form_data":{"post":{"description":"Stores a new form_data.","parameters":[{"in":"query","name":"tab_id","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormDataPostSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the form_data.","type":"string"}},"type":"object"}}},"description":"The form_data was stored successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Explore Form Data"]}},"/api/v1/explore/form_data/{key}":{"delete":{"description":"Deletes a form_data.","parameters":[{"description":"The form_data key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"description":"The result of the operation","type":"string"}},"type":"object"}}},"description":"Deleted the stored form_data."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Explore Form Data"]},"get":{"description":"Retrives a form_data.","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"form_data":{"description":"The stored form_data","type":"string"}},"type":"object"}}},"description":"Returns the stored form_data."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Explore Form Data"]},"put":{"description":"Updates an existing form_data.","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}},{"in":"query","name":"tab_id","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormDataPutSchema"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the form_data.","type":"string"}},"type":"object"}}},"description":"The form_data was stored successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Explore Form Data"]}},"/api/v1/explore/permalink":{"post":{"description":"Stores a new permanent link.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExplorePermalinkStateSchema"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"key":{"description":"The key to retrieve the permanent link data.","type":"string"},"url":{"description":"permanent link.","type":"string"}},"type":"object"}}},"description":"The permanent link was stored successfully."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Explore Permanent Link"]}},"/api/v1/explore/permalink/{key}":{"get":{"description":"Retrives chart state associated with a permanent link.","parameters":[{"in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"state":{"description":"The stored state","type":"object"}},"type":"object"}}},"description":"Returns the stored form_data."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Explore Permanent Link"]}},"/api/v1/log/":{"get":{"description":"Get a list of models","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/LogRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["LogRestApi"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogRestApi.post"}}},"description":"Model schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"$ref":"#/components/schemas/LogRestApi.post"}},"type":"object"}}},"description":"Item inserted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["LogRestApi"]}},"/api/v1/log/recent_activity/":{"get":{"parameters":[{"description":"The id of the user","in":"path","name":"user_id","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_recent_activity_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecentActivityResponseSchema"}}},"description":"A List of recent activity objects"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Get recent activity data for a user","tags":["LogRestApi"]}},"/api/v1/log/{pk}":{"get":{"description":"Get an item model","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/LogRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["LogRestApi"]}},"/api/v1/me/":{"get":{"description":"Returns the user object corresponding to the agent making the request, or returns a 401 error if the user is unauthenticated.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/UserResponseSchema"}},"type":"object"}}},"description":"The current user"},"401":{"$ref":"#/components/responses/401"}},"tags":["Current User"]}},"/api/v1/me/roles/":{"get":{"description":"Returns the user roles corresponding to the agent making the request, or returns a 401 error if the user is unauthenticated.","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/UserResponseSchema"}},"type":"object"}}},"description":"The current user"},"401":{"$ref":"#/components/responses/401"}},"tags":["Current User"]}},"/api/v1/menu/":{"get":{"description":"Get the menu data structure. Returns a forest like structure with the menu the user has access to","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"Menu items in a forest like data structure","items":{"properties":{"childs":{"items":{"type":"object"},"type":"array"},"icon":{"description":"Icon name to show for this menu item","type":"string"},"label":{"description":"Pretty name for the menu item","type":"string"},"name":{"description":"The internal menu item name, maps to permission_name","type":"string"},"url":{"description":"The URL for the menu item","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Get menu data"},"401":{"$ref":"#/components/responses/401"}},"security":[{"jwt":[]}],"tags":["Menu"]}},"/api/v1/query/":{"get":{"description":"Get a list of queries, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/QueryRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/query/distinct/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistincResponseSchema"}}},"description":"Distinct field data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/query/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/query/stop":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopQuerySchema"}}},"description":"Stop query schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"}}},"description":"Query stopped"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Manually stop a query with client_id","tags":["Queries"]}},"/api/v1/query/updated_since":{"get":{"parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries_get_updated_since_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"description":"A List of queries that changed after last_updated_ms","items":{"$ref":"#/components/schemas/QueryRestApi.get"},"type":"array"}},"type":"object"}}},"description":"Queries list"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Get a list of queries that changed after last_updated_ms","tags":["Queries"]}},"/api/v1/query/{pk}":{"get":{"description":"Get query detail information.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/QueryRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/report/":{"delete":{"description":"Deletes multiple report schedules in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Report Schedule bulk delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]},"get":{"description":"Get a list of report schedules, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/ReportScheduleRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]},"post":{"description":"Create a report schedule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportScheduleRestApi.post"}}},"description":"Report Schedule schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/ReportScheduleRestApi.post"}},"type":"object"}}},"description":"Report schedule added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]}},"/api/v1/report/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]}},"/api/v1/report/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]}},"/api/v1/report/{pk}":{"delete":{"description":"Delete a report schedule","parameters":[{"description":"The report schedule pk","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]},"get":{"description":"Get a report schedule","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/ReportScheduleRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]},"put":{"description":"Update a report schedule","parameters":[{"description":"The Report Schedule pk","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportScheduleRestApi.put"}}},"description":"Report Schedule schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/ReportScheduleRestApi.put"}},"type":"object"}}},"description":"Report Schedule changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]}},"/api/v1/report/{pk}/log/":{"get":{"description":"Get a list of report schedule logs, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"description":"The report schedule id for these logs","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total record count on the backend","type":"number"},"ids":{"description":"A list of log ids","items":{"type":"string"},"type":"array"},"result":{"description":"The result from the get list query","items":{"$ref":"#/components/schemas/ReportExecutionLogRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from logs"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]}},"/api/v1/report/{pk}/log/{log_id}":{"get":{"description":"Get a report schedule log","parameters":[{"description":"The report schedule pk for log","in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"description":"The log pk","in":"path","name":"log_id","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"The log id","type":"string"},"result":{"$ref":"#/components/schemas/ReportExecutionLogRestApi.get"}},"type":"object"}}},"description":"Item log"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Report Schedules"]}},"/api/v1/rowlevelsecurity/":{"delete":{"description":"Deletes multiple RLS rules in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"RLS Rule bulk delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]},"get":{"description":"Get a list of models","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/RLSRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]},"post":{"description":"Create a new RLS Rule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RLSRestApi.post"}}},"description":"RLS schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/RLSRestApi.post"}},"type":"object"}}},"description":"RLS Rule added"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]}},"/api/v1/rowlevelsecurity/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]}},"/api/v1/rowlevelsecurity/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]}},"/api/v1/rowlevelsecurity/{pk}":{"delete":{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]},"get":{"description":"Get an item model","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/RLSRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]},"put":{"description":"Updates an RLS Rule","parameters":[{"description":"The Rule pk","in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RLSRestApi.put"}}},"description":"RLS schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"number"},"result":{"$ref":"#/components/schemas/RLSRestApi.put"}},"type":"object"}}},"description":"Rule changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Row Level Security"]}},"/api/v1/saved_query/":{"delete":{"description":"Deletes multiple saved queries in a bulk operation.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_delete_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Saved queries bulk delete"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]},"get":{"description":"Get a list of saved queries, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/SavedQueryRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]},"post":{"description":"Create a saved query","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedQueryRestApi.post"}}},"description":"Model schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"$ref":"#/components/schemas/SavedQueryRestApi.post"}},"type":"object"}}},"description":"Item inserted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/saved_query/_info":{"get":{"description":"Get metadata information about this API resource","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/saved_query/distinct/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DistincResponseSchema"}}},"description":"Distinct field data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/saved_query/export/":{"get":{"description":"Exports multiple saved queries and downloads them as YAML files","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_export_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/zip":{"schema":{"format":"binary","type":"string"}}},"description":"A zip file with saved query(ies) and database(s) as YAML"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/saved_query/import/":{"post":{"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"formData":{"description":"upload file (ZIP)","format":"binary","type":"string"},"overwrite":{"description":"overwrite existing saved queries?","type":"boolean"},"passwords":{"description":"JSON map of passwords for each featured database in the ZIP file. If the ZIP includes a database config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_passwords":{"description":"JSON map of passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the password should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_password\\"}`.","type":"string"},"ssh_tunnel_private_key_passwords":{"description":"JSON map of private_key_passwords for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key_password\\"}`.","type":"string"},"ssh_tunnel_private_keys":{"description":"JSON map of private_keys for each ssh_tunnel associated to a featured database in the ZIP file. If the ZIP includes a ssh_tunnel config in the path `databases/MyDatabase.yaml`, the private_key should be provided in the following format: `{\\"databases/MyDatabase.yaml\\": \\"my_private_key\\"}`.","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Saved Query import result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/saved_query/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/saved_query/{pk}":{"delete":{"description":"Delete saved query","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]},"get":{"description":"Get a saved query","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/SavedQueryRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]},"put":{"description":"Update a saved query","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SavedQueryRestApi.put"}}},"description":"Model schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/SavedQueryRestApi.put"}},"type":"object"}}},"description":"Item changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Queries"]}},"/api/v1/security/csrf_token/":{"get":{"description":"Fetch the CSRF token","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"string"}},"type":"object"}}},"description":"Result contains the CSRF token"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Security"]}},"/api/v1/security/guest_token/":{"post":{"description":"Fetches a guest token","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GuestTokenCreate"}}},"description":"Parameters for the guest token","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"token":{"type":"string"}},"type":"object"}}},"description":"Result contains the guest token"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Security"]}},"/api/v1/security/login":{"post":{"description":"Authenticate and get a JWT access and refresh token","requestBody":{"content":{"application/json":{"schema":{"properties":{"password":{"description":"The password for authentication","example":"complex-password","type":"string"},"provider":{"description":"Choose an authentication provider","enum":["db","ldap"],"example":"db","type":"string"},"refresh":{"description":"If true a refresh token is provided also","example":true,"type":"boolean"},"username":{"description":"The username for authentication","example":"admin","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"access_token":{"type":"string"},"refresh_token":{"type":"string"}},"type":"object"}}},"description":"Authentication Successful"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"tags":["Security"]}},"/api/v1/security/refresh":{"post":{"description":"Use the refresh token to get a new JWT access token","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"access_token":{"description":"A new refreshed access token","type":"string"}},"type":"object"}}},"description":"Refresh Successful"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt_refresh":[]}],"tags":["Security"]}},"/api/v1/sqllab/estimate/":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EstimateQueryCostSchema"}}},"description":"SQL query and params","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Query estimation result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Estimates the SQL query execution cost","tags":["SQL Lab"]}},"/api/v1/sqllab/execute/":{"post":{"description":"Starts the execution of a SQL query","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutePayloadSchema"}}},"description":"SQL query and params","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryExecutionResponseSchema"}}},"description":"Query execution result"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryExecutionResponseSchema"}}},"description":"Query execution result, query still running"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["SQL Lab"]}},"/api/v1/sqllab/export/{client_id}/":{"get":{"parameters":[{"description":"The SQL query result identifier","in":"path","name":"client_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"text/csv":{"schema":{"type":"string"}}},"description":"SQL query results"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Exports the SQL query results to a CSV","tags":["SQL Lab"]}},"/api/v1/sqllab/results/":{"get":{"parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sql_lab_get_results_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryExecutionResponseSchema"}}},"description":"SQL query execution result"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"410":{"$ref":"#/components/responses/410"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"summary":"Gets the result of a SQL query execution","tags":["SQL Lab"]}},"/api/v1/tag/":{"delete":{"description":"Deletes multiple Tags. This will remove all tagged objects with this tag","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete_tags_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Deletes multiple Tags"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]},"get":{"description":"Get a list of tags, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_list_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/TagRestApi.get_list"},"type":"array"}},"type":"object"}}},"description":"Items from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]},"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRestApi.post"}}},"description":"Model schema","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"type":"string"},"result":{"$ref":"#/components/schemas/TagRestApi.post"}},"type":"object"}}},"description":"Item inserted"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/_info":{"get":{"description":"Several metadata information about tag API endpoints.","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_info_schema"}}},"in":"query","name":"q"}],"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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/favorite_status/":{"get":{"description":"Check favorited dashboards for current user","parameters":[{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_fav_star_ids_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFavStarIdsSchema"}}},"description":"None"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/get_objects/":{"get":{"description":"Gets all objects associated with a Tag.","parameters":[{"in":"path","name":"tag_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"items":{"$ref":"#/components/schemas/TaggedObjectEntityResponseSchema"},"type":"array"}},"type":"object"}}},"description":"List of tagged objects associated with a Tag"},"302":{"description":"Redirects to the current digest"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/related/{column_name}":{"get":{"parameters":[{"in":"path","name":"column_name","required":true,"schema":{"type":"string"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_related_schema"}}},"in":"query","name":"q"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelatedResponseSchema"}}},"description":"Related column data"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/{object_type}/{object_id}/":{"post":{"description":"Add tags to an object..","parameters":[{"in":"path","name":"object_type","required":true,"schema":{"type":"integer"}},{"in":"path","name":"object_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"tags":{"description":"list of tag names to add to object","items":{"type":"string"},"type":"array"}},"type":"object"}}},"description":"Tag schema","required":true},"responses":{"201":{"description":"Tag added"},"302":{"description":"Redirects to the current digest"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/{object_type}/{object_id}/{tag}/":{"delete":{"description":"Deletes a Tagged Object.","parameters":[{"in":"path","name":"tag","required":true,"schema":{"type":"string"}},{"in":"path","name":"object_type","required":true,"schema":{"type":"integer"}},{"in":"path","name":"object_id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Chart delete"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/{pk}":{"delete":{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"message":{"type":"string"}},"type":"object"}}},"description":"Item deleted"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]},"get":{"description":"Get a tag detail information.","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}},{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_item_schema"}}},"in":"query","name":"q"}],"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":{"$ref":"#/components/schemas/TagRestApi.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"}}},"description":"Item from Model"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]},"put":{"parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagRestApi.put"}}},"description":"Model schema","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"$ref":"#/components/schemas/TagRestApi.put"}},"type":"object"}}},"description":"Item changed"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/v1/tag/{pk}/favorites/":{"delete":{"description":"Remove the tag from the user favorite list","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Tag removed from favorites"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]},"post":{"description":"Marks the tag as favorite for the current user","parameters":[{"in":"path","name":"pk","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"type":"object"}},"type":"object"}}},"description":"Tag added to favorites"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"422":{"$ref":"#/components/responses/422"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["Tags"]}},"/api/{version}/_openapi":{"get":{"description":"Get the OpenAPI spec for a specific API version","parameters":[{"in":"path","name":"version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"The OpenAPI spec"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}},"security":[{"jwt":[]}],"tags":["OpenApi"]}}},"servers":[{"url":"http://localhost:8088"}]}');var p=s(55784);const c={title:"API",hide_title:!0,sidebar_position:9},l=void 0,m={unversionedId:"api",id:"api",title:"API",description:"API",source:"@site/docs/api.mdx",sourceDirName:".",slug:"/api",permalink:"/docs/api",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/api.mdx",tags:[],version:"current",sidebarPosition:9,frontMatter:{title:"API",hide_title:!0,sidebar_position:9},sidebar:"tutorialSidebar",previous:{title:"Frequently Asked Questions",permalink:"/docs/frequently-asked-questions"},next:{title:"Role based Access",permalink:"/docs/security/"}},d={};s.g.Buffer=n.Buffer;const u=[{value:"API",id:"api",level:2}],h={toc:u},y="wrapper";function g(e){let{components:t,...s}=e;return(0,a.kt)(y,(0,r.Z)({},h,s,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"api"},"API"),(0,a.kt)("p",null,"Superset's public ",(0,a.kt)("strong",{parentName:"p"},"REST API")," follows the\n",(0,a.kt)("a",{parentName:"p",href:"https://swagger.io/specification/"},"OpenAPI specification"),", and is\ndocumented here. The docs below are generated using\n",(0,a.kt)("a",{parentName:"p",href:"https://www.npmjs.com/package/swagger-ui-react"},"Swagger React UI"),"."),(0,a.kt)(p.Z,{type:"info",message:(0,a.kt)("div",null,(0,a.kt)("strong",null,"NOTE! "),"You can find an interactive version of this documentation on your local Superset instance at ",(0,a.kt)("strong",null,"/swagger/v1")," (unless disabled)"),mdxType:"Alert"}),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("hr",null),(0,a.kt)("div",{className:"swagger-container"},(0,a.kt)(o.Z,{spec:i,mdxType:"SwaggerUI"})))}g.isMDXComponent=!0},24654:()=>{}}]);
\ No newline at end of file
diff --git a/assets/js/507542a3.6f0ceed1.js b/assets/js/507542a3.6f0ceed1.js
deleted file mode 100644
index e289e7a..0000000
--- a/assets/js/507542a3.6f0ceed1.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[9594],{96617:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>u});var r=a(83117),n=(a(67294),a(3905)),o=a(51402);const i={title:"Creating Your First Dashboard",hide_title:!0,sidebar_position:1,version:1},s=void 0,l={unversionedId:"creating-charts-dashboards/creating-your-first-dashboard",id:"creating-charts-dashboards/creating-your-first-dashboard",title:"Creating Your First Dashboard",description:"Creating Your First Dashboard",source:"@site/docs/creating-charts-dashboards/creating-your-first-dashboard.mdx",sourceDirName:"creating-charts-dashboards",slug:"/creating-charts-dashboards/creating-your-first-dashboard",permalink:"/docs/creating-charts-dashboards/creating-your-first-dashboard",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/creating-charts-dashboards/creating-your-first-dashboard.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{title:"Creating Your First Dashboard",hide_title:!0,sidebar_position:1,version:1},sidebar:"tutorialSidebar",previous:{title:"Querying across databases",permalink:"/docs/databases/meta-database"},next:{title:"Exploring Data in Superset",permalink:"/docs/creating-charts-dashboards/exploring-data"}},d={},u=[{value:"Creating Your First Dashboard",id:"creating-your-first-dashboard",level:2},{value:"Connecting to a new database",id:"connecting-to-a-new-database",level:3},{value:"Registering a new table",id:"registering-a-new-table",level:3},{value:"Customizing column properties",id:"customizing-column-properties",level:3},{value:"Superset semantic layer",id:"superset-semantic-layer",level:3},{value:"Creating charts in Explore view",id:"creating-charts-in-explore-view",level:3},{value:"Creating a slice and dashboard",id:"creating-a-slice-and-dashboard",level:3},{value:"Manage access to Dashboards",id:"manage-access-to-dashboards",level:3},{value:"Customizing dashboard",id:"customizing-dashboard",level:3}],c={toc:u},p="wrapper";function h(e){let{components:t,...a}=e;return(0,n.kt)(p,(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h2",{id:"creating-your-first-dashboard"},"Creating Your First Dashboard"),(0,n.kt)("p",null,"This section is focused on documentation for end-users who will be using Superset\nfor the data analysis and exploration workflow\n(data analysts, business analysts, data\nscientists, etc). In addition to this site, ",(0,n.kt)("a",{parentName:"p",href:"http://preset.io/"},"Preset.io")," maintains an updated set of end-user\ndocumentation at ",(0,n.kt)("a",{parentName:"p",href:"https://docs.preset.io/"},"docs.preset.io"),"."),(0,n.kt)("p",null,"This tutorial targets someone who wants to create charts and dashboards in Superset. We\u2019ll show you\nhow to connect Superset to a new database and configure a table in that database for analysis.\nYou\u2019ll also explore the data you\u2019ve exposed and add a visualization to a dashboard so that you get a\nfeel for the end-to-end user experience."),(0,n.kt)("h3",{id:"connecting-to-a-new-database"},"Connecting to a new database"),(0,n.kt)("p",null,"Superset itself doesn't have a storage layer to store your data but instead pairs with\nyour existing SQL-speaking database or data store."),(0,n.kt)("p",null,"First things first, we need to add the connection credentials to your database to be able\nto query and visualize data from it. If you're using Superset locally via\n",(0,n.kt)("a",{parentName:"p",href:"/docs/installation/installing-superset-using-docker-compose"},"Docker compose"),", you can\nskip this step because a Postgres database, named ",(0,n.kt)("strong",{parentName:"p"},"examples"),", is included and\npre-configured in Superset for you."),(0,n.kt)("p",null,"Under the ",(0,n.kt)("strong",{parentName:"p"},"+")," menu in the top right, select Data, and then the ",(0,n.kt)("em",{parentName:"p"},"Connect Database")," option:"),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_01_add_database_connection.png"),width:"600"})," "," ",(0,n.kt)("br",null),(0,n.kt)("br",null),(0,n.kt)("p",null,"Then select your database type in the resulting modal:"),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_02_select_database.png"),width:"600"})," "," ",(0,n.kt)("br",null),(0,n.kt)("br",null),(0,n.kt)("p",null,"Once you've selected a database, you can configure a number of advanced options in this window,\nor for the purposes of this this walkthrough, you can click the link below all these fields:"),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_03a_database_connection_string_link.png"),width:"600"})," "," ",(0,n.kt)("br",null),(0,n.kt)("br",null),(0,n.kt)("p",null,"Once you've clicked that link you only need to specify two things (the database name and SQLAlchemy URI):"),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_03b_connection_string_details.png"),width:"600"})," "," ",(0,n.kt)("br",null),(0,n.kt)("br",null),(0,n.kt)("p",null,"As noted in the text below the form, you should refer to the SQLAlchemy documentation on\n",(0,n.kt)("a",{parentName:"p",href:"https://docs.sqlalchemy.org/en/12/core/engines.html#database-urls"},"creating new connection URIs"),"\nfor your target database."),(0,n.kt)("p",null,"Click the ",(0,n.kt)("strong",{parentName:"p"},"Test Connection")," button to confirm things work end to end. If the connection looks good, save the configuration\nby clicking the ",(0,n.kt)("strong",{parentName:"p"},"Connect")," button in the bottom right corner of the modal window:"),(0,n.kt)("p",null,"Congratulations, you've just added a new data source in Superset!"),(0,n.kt)("h3",{id:"registering-a-new-table"},"Registering a new table"),(0,n.kt)("p",null,"Now that you\u2019ve configured a data source, you can select specific tables (called ",(0,n.kt)("strong",{parentName:"p"},"Datasets")," in Superset)\nthat you want exposed in Superset for querying."),(0,n.kt)("p",null,"Navigate to ",(0,n.kt)("strong",{parentName:"p"},"Data \u2023 Datasets")," and select the ",(0,n.kt)("strong",{parentName:"p"},"+ Dataset")," button in the top right corner."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_08_sources_tables.png")}),(0,n.kt)("p",null,"A modal window should pop up in front of you. Select your ",(0,n.kt)("strong",{parentName:"p"},"Database"),",\n",(0,n.kt)("strong",{parentName:"p"},"Schema"),", and ",(0,n.kt)("strong",{parentName:"p"},"Table")," using the drop downs that appear. In the following example,\nwe register the ",(0,n.kt)("strong",{parentName:"p"},"cleaned_sales_data")," table from the ",(0,n.kt)("strong",{parentName:"p"},"examples")," database."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_09_add_new_table.png")}),(0,n.kt)("p",null,"To finish, click the ",(0,n.kt)("strong",{parentName:"p"},"Add")," button in the bottom right corner. You should now see your dataset in the list of datasets."),(0,n.kt)("h3",{id:"customizing-column-properties"},"Customizing column properties"),(0,n.kt)("p",null,"Now that you've registered your dataset, you can configure column properties\nfor how the column should be treated in the Explore workflow:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Is the column temporal? (should it be used for slicing & dicing in time series charts?)"),(0,n.kt)("li",{parentName:"ul"},"Should the column be filterable?"),(0,n.kt)("li",{parentName:"ul"},"Is the column dimensional?"),(0,n.kt)("li",{parentName:"ul"},"If it's a datetime column, how should Superset parse\nthe datetime format? (using the ",(0,n.kt)("a",{parentName:"li",href:"https://en.wikipedia.org/wiki/ISO_8601"},"ISO-8601 string pattern"),")")),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_column_properties.png")}),(0,n.kt)("h3",{id:"superset-semantic-layer"},"Superset semantic layer"),(0,n.kt)("p",null,"Superset has a thin semantic layer that adds many quality of life improvements for analysts.\nThe Superset semantic layer can store 2 types of computed data:"),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},"Virtual metrics: you can write SQL queries that aggregate values\nfrom multiple column (e.g. ",(0,n.kt)("inlineCode",{parentName:"li"},"SUM(recovered) / SUM(confirmed)"),") and make them\navailable as columns for (e.g. ",(0,n.kt)("inlineCode",{parentName:"li"},"recovery_rate"),") visualization in Explore.\nAggregate functions are allowed and encouraged for metrics.")),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_sql_metric.png")}),(0,n.kt)("p",null,"You can also certify metrics if you'd like for your team in this view."),(0,n.kt)("ol",{start:2},(0,n.kt)("li",{parentName:"ol"},"Virtual calculated columns: you can write SQL queries that\ncustomize the appearance and behavior\nof a specific column (e.g. ",(0,n.kt)("inlineCode",{parentName:"li"},"CAST(recovery_rate) as float"),").\nAggregate functions aren't allowed in calculated columns.")),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_calculated_column.png")}),(0,n.kt)("h3",{id:"creating-charts-in-explore-view"},"Creating charts in Explore view"),(0,n.kt)("p",null,"Superset has 2 main interfaces for exploring data:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("strong",{parentName:"li"},"Explore"),": no-code viz builder. Select your dataset, select the chart,\ncustomize the appearance, and publish."),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("strong",{parentName:"li"},"SQL Lab"),": SQL IDE for cleaning, joining, and preparing data for Explore workflow")),(0,n.kt)("p",null,"We'll focus on the Explore view for creating charts right now.\nTo start the Explore workflow from the ",(0,n.kt)("strong",{parentName:"p"},"Datasets")," tab, start by clicking the name\nof the dataset that will be powering your chart."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_launch_explore.png")}),(0,n.kt)("br",null),(0,n.kt)("br",null),(0,n.kt)("p",null,"You're now presented with a powerful workflow for exploring data and iterating on charts."),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"The ",(0,n.kt)("strong",{parentName:"li"},"Dataset")," view on the left-hand side has a list of columns and metrics,\nscoped to the current dataset you selected."),(0,n.kt)("li",{parentName:"ul"},"The ",(0,n.kt)("strong",{parentName:"li"},"Data")," preview below the chart area also gives you helpful data context."),(0,n.kt)("li",{parentName:"ul"},"Using the ",(0,n.kt)("strong",{parentName:"li"},"Data")," tab and ",(0,n.kt)("strong",{parentName:"li"},"Customize")," tabs, you can change the visualization type,\nselect the temporal column, select the metric to group by, and customize\nthe aesthetics of the chart.")),(0,n.kt)("p",null,"As you customize your chart using drop-down menus, make sure to click the ",(0,n.kt)("strong",{parentName:"p"},"Run")," button\nto get visual feedback."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_explore_run.jpg")}),(0,n.kt)("p",null,"In the following screenshot, we craft a grouped Time-series Bar Chart to visualize\nour quarterly sales data by product line just by clicking options in drop-down menus."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_explore_settings.jpg")}),(0,n.kt)("h3",{id:"creating-a-slice-and-dashboard"},"Creating a slice and dashboard"),(0,n.kt)("p",null,"To save your chart, first click the ",(0,n.kt)("strong",{parentName:"p"},"Save")," button. You can either:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Save your chart and add it to an existing dashboard"),(0,n.kt)("li",{parentName:"ul"},"Save your chart and add it to a new dashboard")),(0,n.kt)("p",null,'In the following screenshot, we save the chart to a new "Superset Duper Sales Dashboard":'),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_save_slice.png")}),(0,n.kt)("p",null,"To publish, click ",(0,n.kt)("strong",{parentName:"p"},"Save and goto Dashboard"),"."),(0,n.kt)("p",null,"Behind the scenes, Superset will create a slice and store all the information needed\nto create your chart in its thin data layer\n(the query, chart type, options selected, name, etc)."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_first_dashboard.png"),style:{width:"100%",maxWidth:"500px"}}),(0,n.kt)("p",null," To resize the chart, start by clicking the Edit Dashboard button in the top right corner."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_edit_button.png"),width:"300"}),(0,n.kt)("p",null,"Then, click and drag the bottom right corner of the chart until the chart layout snaps\ninto a position you like onto the underlying grid."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_chart_resize.png"),style:{width:"100%",maxWidth:"500px"}}),(0,n.kt)("p",null," Click ",(0,n.kt)("strong",{parentName:"p"},"Save")," to persist the changes."),(0,n.kt)("p",null,"Congrats! You\u2019ve successfully linked, analyzed, and visualized data in Superset. There are a wealth\nof other table configuration and visualization options, so please start exploring and creating\nslices and dashboards of your own"),(0,n.kt)("p",null,"\u05bf"),(0,n.kt)("h3",{id:"manage-access-to-dashboards"},"Manage access to Dashboards"),(0,n.kt)("p",null,"Access to dashboards is managed via owners (users that have edit permissions to the dashboard)"),(0,n.kt)("p",null,"Non-owner users access can be managed two different ways:"),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},"Dataset permissions - if you add to the relevant role permissions to datasets it automatically grants implicit access to all dashboards that uses those permitted datasets"),(0,n.kt)("li",{parentName:"ol"},"Dashboard roles - if you enable ",(0,n.kt)("strong",{parentName:"li"},"DASHBOARD_RBAC")," ",(0,n.kt)("a",{parentName:"li",href:"https://superset.apache.org/docs/installation/configuring-superset#feature-flags"},"feature flag")," then you be able to manage which roles can access the dashboard",(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Granting a role access to a dashboard will bypass dataset level checks. Having dashboard access implicitly grants read access to all the featured charts in the dashboard, and thereby also all the associated datasets."),(0,n.kt)("li",{parentName:"ul"},"If no roles are specified for a dashboard, regular ",(0,n.kt)("strong",{parentName:"li"},"Dataset permissions")," will apply.")))),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_dashboard_access.png")}),(0,n.kt)("h3",{id:"customizing-dashboard"},"Customizing dashboard"),(0,n.kt)("p",null,"The following URL parameters can be used to modify how the dashboard is rendered:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"standalone"),":",(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"0")," (default): dashboard is displayed normally"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"1"),": Top Navigation is hidden"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"2"),": Top Navigation + title is hidden"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"3"),": Top Navigation + title + top level tabs are hidden"))),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"show_filters"),":",(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"0"),": render dashboard without Filter Bar"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"1")," (default): render dashboard with Filter Bar if native filters are enabled"))),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"expand_filters"),":",(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"(default): render dashboard with Filter Bar expanded if there are native filters"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"0"),": render dashboard with Filter Bar collapsed"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"1"),": render dashboard with Filter Bar expanded")))),(0,n.kt)("p",null,"For example, when running the local development build, the following will disable the\nTop Nav and remove the Filter Bar:\n",(0,n.kt)("inlineCode",{parentName:"p"},"http://localhost:8088/superset/dashboard/my-dashboard/?standalone=1&show_filters=0")))}h.isMDXComponent=!0},3905:(e,t,a)=>{a.d(t,{Zo:()=>u,kt:()=>m});var r=a(67294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?o(Object(a),!0).forEach((function(t){n(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):o(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function s(e,t){if(null==e)return{};var a,r,n=function(e,t){if(null==e)return{};var a,r,n={},o=Object.keys(e);for(r=0;r<o.length;r++)a=o[r],t.indexOf(a)>=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r<o.length;r++)a=o[r],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},u=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},c="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,l=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),c=d(a),h=n,m=c["".concat(l,".").concat(h)]||c[h]||p[h]||o;return a?r.createElement(m,i(i({ref:t},u),{},{components:a})):r.createElement(m,i({ref:t},u))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,i=new Array(o);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:n,i[1]=s;for(var d=2;d<o;d++)i[d]=a[d];return r.createElement.apply(null,i)}return r.createElement.apply(null,a)}h.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/507542a3.e5fff5b5.js b/assets/js/507542a3.e5fff5b5.js
new file mode 100644
index 0000000..521e017
--- /dev/null
+++ b/assets/js/507542a3.e5fff5b5.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[9594],{96617:(e,t,a)=>{a.r(t),a.d(t,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>u});var r=a(83117),n=(a(67294),a(3905)),o=a(51402);const i={title:"Creating Your First Dashboard",hide_title:!0,sidebar_position:1,version:1},s=void 0,l={unversionedId:"creating-charts-dashboards/creating-your-first-dashboard",id:"creating-charts-dashboards/creating-your-first-dashboard",title:"Creating Your First Dashboard",description:"Creating Your First Dashboard",source:"@site/docs/creating-charts-dashboards/creating-your-first-dashboard.mdx",sourceDirName:"creating-charts-dashboards",slug:"/creating-charts-dashboards/creating-your-first-dashboard",permalink:"/docs/creating-charts-dashboards/creating-your-first-dashboard",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/creating-charts-dashboards/creating-your-first-dashboard.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{title:"Creating Your First Dashboard",hide_title:!0,sidebar_position:1,version:1},sidebar:"tutorialSidebar",previous:{title:"Querying across databases",permalink:"/docs/databases/meta-database"},next:{title:"Exploring Data in Superset",permalink:"/docs/creating-charts-dashboards/exploring-data"}},d={},u=[{value:"Creating Your First Dashboard",id:"creating-your-first-dashboard",level:2},{value:"Connecting to a new database",id:"connecting-to-a-new-database",level:3},{value:"Registering a new table",id:"registering-a-new-table",level:3},{value:"Customizing column properties",id:"customizing-column-properties",level:3},{value:"Superset semantic layer",id:"superset-semantic-layer",level:3},{value:"Creating charts in Explore view",id:"creating-charts-in-explore-view",level:3},{value:"Creating a slice and dashboard",id:"creating-a-slice-and-dashboard",level:3},{value:"Manage access to Dashboards",id:"manage-access-to-dashboards",level:3},{value:"Customizing dashboard",id:"customizing-dashboard",level:3}],c={toc:u},p="wrapper";function h(e){let{components:t,...a}=e;return(0,n.kt)(p,(0,r.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h2",{id:"creating-your-first-dashboard"},"Creating Your First Dashboard"),(0,n.kt)("p",null,"This section is focused on documentation for end-users who will be using Superset\nfor the data analysis and exploration workflow\n(data analysts, business analysts, data\nscientists, etc). In addition to this site, ",(0,n.kt)("a",{parentName:"p",href:"http://preset.io/"},"Preset.io")," maintains an updated set of end-user\ndocumentation at ",(0,n.kt)("a",{parentName:"p",href:"https://docs.preset.io/"},"docs.preset.io"),"."),(0,n.kt)("p",null,"This tutorial targets someone who wants to create charts and dashboards in Superset. We\u2019ll show you\nhow to connect Superset to a new database and configure a table in that database for analysis.\nYou\u2019ll also explore the data you\u2019ve exposed and add a visualization to a dashboard so that you get a\nfeel for the end-to-end user experience."),(0,n.kt)("h3",{id:"connecting-to-a-new-database"},"Connecting to a new database"),(0,n.kt)("p",null,"Superset itself doesn't have a storage layer to store your data but instead pairs with\nyour existing SQL-speaking database or data store."),(0,n.kt)("p",null,"First things first, we need to add the connection credentials to your database to be able\nto query and visualize data from it. If you're using Superset locally via\n",(0,n.kt)("a",{parentName:"p",href:"/docs/installation/installing-superset-using-docker-compose"},"Docker compose"),", you can\nskip this step because a Postgres database, named ",(0,n.kt)("strong",{parentName:"p"},"examples"),", is included and\npre-configured in Superset for you."),(0,n.kt)("p",null,"Under the ",(0,n.kt)("strong",{parentName:"p"},"+")," menu in the top right, select Data, and then the ",(0,n.kt)("em",{parentName:"p"},"Connect Database")," option:"),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_01_add_database_connection.png"),width:"600"})," "," ",(0,n.kt)("br",null),(0,n.kt)("br",null),(0,n.kt)("p",null,"Then select your database type in the resulting modal:"),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_02_select_database.png"),width:"600"})," "," ",(0,n.kt)("br",null),(0,n.kt)("br",null),(0,n.kt)("p",null,"Once you've selected a database, you can configure a number of advanced options in this window,\nor for the purposes of this walkthrough, you can click the link below all these fields:"),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_03a_database_connection_string_link.png"),width:"600"})," "," ",(0,n.kt)("br",null),(0,n.kt)("br",null),(0,n.kt)("p",null,"Once you've clicked that link you only need to specify two things (the database name and SQLAlchemy URI):"),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_03b_connection_string_details.png"),width:"600"})," "," ",(0,n.kt)("br",null),(0,n.kt)("br",null),(0,n.kt)("p",null,"As noted in the text below the form, you should refer to the SQLAlchemy documentation on\n",(0,n.kt)("a",{parentName:"p",href:"https://docs.sqlalchemy.org/en/12/core/engines.html#database-urls"},"creating new connection URIs"),"\nfor your target database."),(0,n.kt)("p",null,"Click the ",(0,n.kt)("strong",{parentName:"p"},"Test Connection")," button to confirm things work end to end. If the connection looks good, save the configuration\nby clicking the ",(0,n.kt)("strong",{parentName:"p"},"Connect")," button in the bottom right corner of the modal window:"),(0,n.kt)("p",null,"Congratulations, you've just added a new data source in Superset!"),(0,n.kt)("h3",{id:"registering-a-new-table"},"Registering a new table"),(0,n.kt)("p",null,"Now that you\u2019ve configured a data source, you can select specific tables (called ",(0,n.kt)("strong",{parentName:"p"},"Datasets")," in Superset)\nthat you want exposed in Superset for querying."),(0,n.kt)("p",null,"Navigate to ",(0,n.kt)("strong",{parentName:"p"},"Data \u2023 Datasets")," and select the ",(0,n.kt)("strong",{parentName:"p"},"+ Dataset")," button in the top right corner."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_08_sources_tables.png")}),(0,n.kt)("p",null,"A modal window should pop up in front of you. Select your ",(0,n.kt)("strong",{parentName:"p"},"Database"),",\n",(0,n.kt)("strong",{parentName:"p"},"Schema"),", and ",(0,n.kt)("strong",{parentName:"p"},"Table")," using the drop downs that appear. In the following example,\nwe register the ",(0,n.kt)("strong",{parentName:"p"},"cleaned_sales_data")," table from the ",(0,n.kt)("strong",{parentName:"p"},"examples")," database."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_09_add_new_table.png")}),(0,n.kt)("p",null,"To finish, click the ",(0,n.kt)("strong",{parentName:"p"},"Add")," button in the bottom right corner. You should now see your dataset in the list of datasets."),(0,n.kt)("h3",{id:"customizing-column-properties"},"Customizing column properties"),(0,n.kt)("p",null,"Now that you've registered your dataset, you can configure column properties\nfor how the column should be treated in the Explore workflow:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Is the column temporal? (should it be used for slicing & dicing in time series charts?)"),(0,n.kt)("li",{parentName:"ul"},"Should the column be filterable?"),(0,n.kt)("li",{parentName:"ul"},"Is the column dimensional?"),(0,n.kt)("li",{parentName:"ul"},"If it's a datetime column, how should Superset parse\nthe datetime format? (using the ",(0,n.kt)("a",{parentName:"li",href:"https://en.wikipedia.org/wiki/ISO_8601"},"ISO-8601 string pattern"),")")),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_column_properties.png")}),(0,n.kt)("h3",{id:"superset-semantic-layer"},"Superset semantic layer"),(0,n.kt)("p",null,"Superset has a thin semantic layer that adds many quality of life improvements for analysts.\nThe Superset semantic layer can store 2 types of computed data:"),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},"Virtual metrics: you can write SQL queries that aggregate values\nfrom multiple column (e.g. ",(0,n.kt)("inlineCode",{parentName:"li"},"SUM(recovered) / SUM(confirmed)"),") and make them\navailable as columns for (e.g. ",(0,n.kt)("inlineCode",{parentName:"li"},"recovery_rate"),") visualization in Explore.\nAggregate functions are allowed and encouraged for metrics.")),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_sql_metric.png")}),(0,n.kt)("p",null,"You can also certify metrics if you'd like for your team in this view."),(0,n.kt)("ol",{start:2},(0,n.kt)("li",{parentName:"ol"},"Virtual calculated columns: you can write SQL queries that\ncustomize the appearance and behavior\nof a specific column (e.g. ",(0,n.kt)("inlineCode",{parentName:"li"},"CAST(recovery_rate) as float"),").\nAggregate functions aren't allowed in calculated columns.")),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_calculated_column.png")}),(0,n.kt)("h3",{id:"creating-charts-in-explore-view"},"Creating charts in Explore view"),(0,n.kt)("p",null,"Superset has 2 main interfaces for exploring data:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("strong",{parentName:"li"},"Explore"),": no-code viz builder. Select your dataset, select the chart,\ncustomize the appearance, and publish."),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("strong",{parentName:"li"},"SQL Lab"),": SQL IDE for cleaning, joining, and preparing data for Explore workflow")),(0,n.kt)("p",null,"We'll focus on the Explore view for creating charts right now.\nTo start the Explore workflow from the ",(0,n.kt)("strong",{parentName:"p"},"Datasets")," tab, start by clicking the name\nof the dataset that will be powering your chart."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_launch_explore.png")}),(0,n.kt)("br",null),(0,n.kt)("br",null),(0,n.kt)("p",null,"You're now presented with a powerful workflow for exploring data and iterating on charts."),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"The ",(0,n.kt)("strong",{parentName:"li"},"Dataset")," view on the left-hand side has a list of columns and metrics,\nscoped to the current dataset you selected."),(0,n.kt)("li",{parentName:"ul"},"The ",(0,n.kt)("strong",{parentName:"li"},"Data")," preview below the chart area also gives you helpful data context."),(0,n.kt)("li",{parentName:"ul"},"Using the ",(0,n.kt)("strong",{parentName:"li"},"Data")," tab and ",(0,n.kt)("strong",{parentName:"li"},"Customize")," tabs, you can change the visualization type,\nselect the temporal column, select the metric to group by, and customize\nthe aesthetics of the chart.")),(0,n.kt)("p",null,"As you customize your chart using drop-down menus, make sure to click the ",(0,n.kt)("strong",{parentName:"p"},"Run")," button\nto get visual feedback."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_explore_run.jpg")}),(0,n.kt)("p",null,"In the following screenshot, we craft a grouped Time-series Bar Chart to visualize\nour quarterly sales data by product line just by clicking options in drop-down menus."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_explore_settings.jpg")}),(0,n.kt)("h3",{id:"creating-a-slice-and-dashboard"},"Creating a slice and dashboard"),(0,n.kt)("p",null,"To save your chart, first click the ",(0,n.kt)("strong",{parentName:"p"},"Save")," button. You can either:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Save your chart and add it to an existing dashboard"),(0,n.kt)("li",{parentName:"ul"},"Save your chart and add it to a new dashboard")),(0,n.kt)("p",null,'In the following screenshot, we save the chart to a new "Superset Duper Sales Dashboard":'),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_save_slice.png")}),(0,n.kt)("p",null,"To publish, click ",(0,n.kt)("strong",{parentName:"p"},"Save and goto Dashboard"),"."),(0,n.kt)("p",null,"Behind the scenes, Superset will create a slice and store all the information needed\nto create your chart in its thin data layer\n(the query, chart type, options selected, name, etc)."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_first_dashboard.png"),style:{width:"100%",maxWidth:"500px"}}),(0,n.kt)("p",null," To resize the chart, start by clicking the Edit Dashboard button in the top right corner."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_edit_button.png"),width:"300"}),(0,n.kt)("p",null,"Then, click and drag the bottom right corner of the chart until the chart layout snaps\ninto a position you like onto the underlying grid."),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_chart_resize.png"),style:{width:"100%",maxWidth:"500px"}}),(0,n.kt)("p",null," Click ",(0,n.kt)("strong",{parentName:"p"},"Save")," to persist the changes."),(0,n.kt)("p",null,"Congrats! You\u2019ve successfully linked, analyzed, and visualized data in Superset. There are a wealth\nof other table configuration and visualization options, so please start exploring and creating\nslices and dashboards of your own"),(0,n.kt)("p",null,"\u05bf"),(0,n.kt)("h3",{id:"manage-access-to-dashboards"},"Manage access to Dashboards"),(0,n.kt)("p",null,"Access to dashboards is managed via owners (users that have edit permissions to the dashboard)"),(0,n.kt)("p",null,"Non-owner users access can be managed two different ways:"),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},"Dataset permissions - if you add to the relevant role permissions to datasets it automatically grants implicit access to all dashboards that uses those permitted datasets"),(0,n.kt)("li",{parentName:"ol"},"Dashboard roles - if you enable ",(0,n.kt)("strong",{parentName:"li"},"DASHBOARD_RBAC")," ",(0,n.kt)("a",{parentName:"li",href:"https://superset.apache.org/docs/installation/configuring-superset#feature-flags"},"feature flag")," then you be able to manage which roles can access the dashboard",(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Granting a role access to a dashboard will bypass dataset level checks. Having dashboard access implicitly grants read access to all the featured charts in the dashboard, and thereby also all the associated datasets."),(0,n.kt)("li",{parentName:"ul"},"If no roles are specified for a dashboard, regular ",(0,n.kt)("strong",{parentName:"li"},"Dataset permissions")," will apply.")))),(0,n.kt)("img",{src:(0,o.Z)("/img/tutorial/tutorial_dashboard_access.png")}),(0,n.kt)("h3",{id:"customizing-dashboard"},"Customizing dashboard"),(0,n.kt)("p",null,"The following URL parameters can be used to modify how the dashboard is rendered:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"standalone"),":",(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"0")," (default): dashboard is displayed normally"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"1"),": Top Navigation is hidden"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"2"),": Top Navigation + title is hidden"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"3"),": Top Navigation + title + top level tabs are hidden"))),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"show_filters"),":",(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"0"),": render dashboard without Filter Bar"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"1")," (default): render dashboard with Filter Bar if native filters are enabled"))),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"expand_filters"),":",(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"(default): render dashboard with Filter Bar expanded if there are native filters"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"0"),": render dashboard with Filter Bar collapsed"),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"1"),": render dashboard with Filter Bar expanded")))),(0,n.kt)("p",null,"For example, when running the local development build, the following will disable the\nTop Nav and remove the Filter Bar:\n",(0,n.kt)("inlineCode",{parentName:"p"},"http://localhost:8088/superset/dashboard/my-dashboard/?standalone=1&show_filters=0")))}h.isMDXComponent=!0},3905:(e,t,a)=>{a.d(t,{Zo:()=>u,kt:()=>m});var r=a(67294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?o(Object(a),!0).forEach((function(t){n(e,t,a[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):o(Object(a)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))}))}return e}function s(e,t){if(null==e)return{};var a,r,n=function(e,t){if(null==e)return{};var a,r,n={},o=Object.keys(e);for(r=0;r<o.length;r++)a=o[r],t.indexOf(a)>=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r<o.length;r++)a=o[r],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),d=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},u=function(e){var t=d(e.components);return r.createElement(l.Provider,{value:t},e.children)},c="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},h=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,l=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),c=d(a),h=n,m=c["".concat(l,".").concat(h)]||c[h]||p[h]||o;return a?r.createElement(m,i(i({ref:t},u),{},{components:a})):r.createElement(m,i({ref:t},u))}));function m(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,i=new Array(o);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[c]="string"==typeof e?e:n,i[1]=s;for(var d=2;d<o;d++)i[d]=a[d];return r.createElement.apply(null,i)}return r.createElement.apply(null,a)}h.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/5e50ba72.2b277921.js b/assets/js/5e50ba72.2b277921.js
new file mode 100644
index 0000000..b0474aa
--- /dev/null
+++ b/assets/js/5e50ba72.2b277921.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[4014],{79874:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var a=n(83117),r=(n(67294),n(3905));const i={title:"Translating",hide_title:!0,sidebar_position:9,version:1},l=void 0,o={unversionedId:"contributing/translations",id:"contributing/translations",title:"Translating",description:"Translating",source:"@site/docs/contributing/translations.mdx",sourceDirName:"contributing",slug:"/contributing/translations",permalink:"/docs/contributing/translations",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/contributing/translations.mdx",tags:[],version:"current",sidebarPosition:9,frontMatter:{title:"Translating",hide_title:!0,sidebar_position:9,version:1},sidebar:"tutorialSidebar",previous:{title:"Testing",permalink:"/docs/contributing/testing-locally"},next:{title:"Creating Visualization Plugins",permalink:"/docs/contributing/creating-viz-plugins"}},s={},p=[{value:"Translating",id:"translating",level:2},{value:"Enabling language selection",id:"enabling-language-selection",level:3},{value:"Creating a new language dictionary",id:"creating-a-new-language-dictionary",level:3},{value:"Extracting new strings for translation",id:"extracting-new-strings-for-translation",level:3},{value:"Updating language files",id:"updating-language-files",level:3},{value:"Applying translations",id:"applying-translations",level:3}],u={toc:p},g="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(g,(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"translating"},"Translating"),(0,r.kt)("p",null,"We use ",(0,r.kt)("a",{parentName:"p",href:"https://python-babel.github.io/flask-babel/"},"Flask-Babel")," to translate Superset.\nIn Python files, we use the following\n",(0,r.kt)("a",{parentName:"p",href:"https://python-babel.github.io/flask-babel/#using-translations"},"translation functions"),"\nfrom ",(0,r.kt)("inlineCode",{parentName:"p"},"Flask-Babel"),":"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"gettext")," and ",(0,r.kt)("inlineCode",{parentName:"li"},"lazy_gettext")," (usually aliased to ",(0,r.kt)("inlineCode",{parentName:"li"},"_"),"): for translating singular\nstrings."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ngettext"),": for translating strings that might become plural.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-python"},"from flask_babel import lazy_gettext as _\n")),(0,r.kt)("p",null,"then wrap the translatable strings with it, e.g. ",(0,r.kt)("inlineCode",{parentName:"p"},"_('Translate me')"),".\nDuring extraction, string literals passed to ",(0,r.kt)("inlineCode",{parentName:"p"},"_")," will be added to the\ngenerated ",(0,r.kt)("inlineCode",{parentName:"p"},".po")," file for each language for later translation."),(0,r.kt)("p",null,"At runtime, the ",(0,r.kt)("inlineCode",{parentName:"p"},"_")," function will return the translation of the given\nstring for the current language, or the given string itself\nif no translation is available."),(0,r.kt)("p",null,"In TypeScript/JavaScript, the technique is similar:\nwe import ",(0,r.kt)("inlineCode",{parentName:"p"},"t")," (simple translation), ",(0,r.kt)("inlineCode",{parentName:"p"},"tn")," (translation containing a number)."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'import { t, tn } from "@superset-ui/translation";\n')),(0,r.kt)("h3",{id:"enabling-language-selection"},"Enabling language selection"),(0,r.kt)("p",null,"Add the ",(0,r.kt)("inlineCode",{parentName:"p"},"LANGUAGES")," variable to your ",(0,r.kt)("inlineCode",{parentName:"p"},"superset_config.py"),". Having more than one\noption inside will add a language selection dropdown to the UI on the right side\nof the navigation bar."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-python"},"LANGUAGES = {\n 'en': {'flag': 'us', 'name': 'English'},\n 'fr': {'flag': 'fr', 'name': 'French'},\n 'zh': {'flag': 'cn', 'name': 'Chinese'},\n}\n")),(0,r.kt)("h3",{id:"creating-a-new-language-dictionary"},"Creating a new language dictionary"),(0,r.kt)("p",null,"First check if the language code for your target language already exists. Check if the\n",(0,r.kt)("a",{parentName:"p",href:"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes"},"two letter ISO 639-1 code"),"\nfor your target language already exists in the ",(0,r.kt)("inlineCode",{parentName:"p"},"superset/translations")," directory:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},'ls superset/translations | grep -E "^[a-z]{2}\\/"\n')),(0,r.kt)("p",null,"If your language already has a preexisting translation, skip to the next section"),(0,r.kt)("p",null,"The following languages are already supported by Flask AppBuilder, and will make it\neasier to translate the application to your target language:\n",(0,r.kt)("a",{parentName:"p",href:"https://flask-appbuilder.readthedocs.io/en/latest/i18n.html"},"Flask AppBuilder i18n documentation")),(0,r.kt)("p",null,"To create a dictionary for a new language, first make sure the necessary dependencies are installed:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"pip install -r superset/translations/requirements.txt\n")),(0,r.kt)("p",null,"Then run the following, where ",(0,r.kt)("inlineCode",{parentName:"p"},"LANGUAGE_CODE")," is replaced with the language code for your target\nlanguage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"pybabel init -i superset/translations/messages.pot -d superset/translations -l LANGUAGE_CODE\n")),(0,r.kt)("p",null,"For instance, to add a translation for Finnish (language code ",(0,r.kt)("inlineCode",{parentName:"p"},"fi"),"), run the following:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"pybabel init -i superset/translations/messages.pot -d superset/translations -l fi\n")),(0,r.kt)("h3",{id:"extracting-new-strings-for-translation"},"Extracting new strings for translation"),(0,r.kt)("p",null,"This step needs to be done every time application strings change. This happens fairly\nfrequently, so if you want to ensure that your translation has good coverage, this\nstep needs to be run fairly frequently and the updated strings merged to the upstream\ncodebase via PRs. To update the template file ",(0,r.kt)("inlineCode",{parentName:"p"},"superset/translations/messages.pot"),"\nwith current application strings, run the following command:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"pybabel extract -F superset/translations/babel.cfg -o superset/translations/messages.pot -k _ -k __ -k t -k tn -k tct .\n")),(0,r.kt)("p",null,"Do not forget to update this file with the appropriate license information."),(0,r.kt)("h3",{id:"updating-language-files"},"Updating language files"),(0,r.kt)("p",null,"Run the following command to update the language files with the new extracted strings."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"}," pybabel update -i superset/translations/messages.pot -d superset/translations --ignore-obsolete\n")),(0,r.kt)("p",null,"You can then translate the strings gathered in files located under\n",(0,r.kt)("inlineCode",{parentName:"p"},"superset/translation"),", where there's one folder per language. You can use ",(0,r.kt)("a",{parentName:"p",href:"https://poedit.net/features"},"Poedit"),"\nto translate the ",(0,r.kt)("inlineCode",{parentName:"p"},"po")," file more conveniently.\nHere is ",(0,r.kt)("a",{parentName:"p",href:"https://web.archive.org/web/20220517065036/https://wiki.lxde.org/en/Translate_*.po_files_with_Poedit"},"a tutorial"),"."),(0,r.kt)("p",null,"To perform the translation on MacOS, you can install ",(0,r.kt)("inlineCode",{parentName:"p"},"poedit")," via Homebrew:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"brew install poedit\n")),(0,r.kt)("p",null,"After this, just start the ",(0,r.kt)("inlineCode",{parentName:"p"},"poedit")," application and open the ",(0,r.kt)("inlineCode",{parentName:"p"},"messages.po")," file. In the\ncase of the Finnish translation, this would be ",(0,r.kt)("inlineCode",{parentName:"p"},"superset/translations/fi/LC_MESSAGES/messages.po"),"."),(0,r.kt)("h3",{id:"applying-translations"},"Applying translations"),(0,r.kt)("p",null,"To make the translations available on the frontend, we need to convert the PO file into\na JSON file. To do this, we need to globally install the npm package ",(0,r.kt)("inlineCode",{parentName:"p"},"po2json"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"npm install -g po2json\n")),(0,r.kt)("p",null,"To convert all PO files to formatted JSON files you can use the ",(0,r.kt)("inlineCode",{parentName:"p"},"po2json.sh")," script."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"./scripts/po2json.sh\n")),(0,r.kt)("p",null,"If you get errors running ",(0,r.kt)("inlineCode",{parentName:"p"},"po2json"),", you might be running the Ubuntu package with the same\nname, rather than the Node.js package (they have a different format for the arguments). If\nthere is a conflict, you may need to update your ",(0,r.kt)("inlineCode",{parentName:"p"},"PATH")," environment variable or fully qualify\nthe executable path (e.g. ",(0,r.kt)("inlineCode",{parentName:"p"},"/usr/local/bin/po2json")," instead of ",(0,r.kt)("inlineCode",{parentName:"p"},"po2json"),").\nIf you get a lot of ",(0,r.kt)("inlineCode",{parentName:"p"},"[null,***]")," in ",(0,r.kt)("inlineCode",{parentName:"p"},"messages.json"),", just delete all the ",(0,r.kt)("inlineCode",{parentName:"p"},"null,"),".\nFor example, ",(0,r.kt)("inlineCode",{parentName:"p"},'"year":["\u5e74"]')," is correct while ",(0,r.kt)("inlineCode",{parentName:"p"},'"year":[null,"\u5e74"]'),"is incorrect."),(0,r.kt)("p",null,"Finally, for the translations to take effect we need to compile translation catalogs into\nbinary MO files."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"pybabel compile -d superset/translations\n")))}c.isMDXComponent=!0},3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function o(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},i=Object.keys(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},u=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},g="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),g=p(n),d=r,m=g["".concat(s,".").concat(d)]||g[d]||c[d]||i;return n?a.createElement(m,l(l({ref:t},u),{},{components:n})):a.createElement(m,l({ref:t},u))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=d;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[g]="string"==typeof e?e:r,l[1]=o;for(var p=2;p<i;p++)l[p]=n[p];return a.createElement.apply(null,l)}return a.createElement.apply(null,n)}d.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/5e50ba72.e794fd15.js b/assets/js/5e50ba72.e794fd15.js
deleted file mode 100644
index 1b3cb44..0000000
--- a/assets/js/5e50ba72.e794fd15.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[4014],{79874:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>p});var a=n(83117),r=(n(67294),n(3905));const i={title:"Translating",hide_title:!0,sidebar_position:9,version:1},l=void 0,o={unversionedId:"contributing/translations",id:"contributing/translations",title:"Translating",description:"Translating",source:"@site/docs/contributing/translations.mdx",sourceDirName:"contributing",slug:"/contributing/translations",permalink:"/docs/contributing/translations",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/contributing/translations.mdx",tags:[],version:"current",sidebarPosition:9,frontMatter:{title:"Translating",hide_title:!0,sidebar_position:9,version:1},sidebar:"tutorialSidebar",previous:{title:"Testing",permalink:"/docs/contributing/testing-locally"},next:{title:"Creating Visualization Plugins",permalink:"/docs/contributing/creating-viz-plugins"}},s={},p=[{value:"Translating",id:"translating",level:2},{value:"Enabling language selection",id:"enabling-language-selection",level:3},{value:"Creating a new language dictionary",id:"creating-a-new-language-dictionary",level:3},{value:"Extracting new strings for translation",id:"extracting-new-strings-for-translation",level:3},{value:"Updating language files",id:"updating-language-files",level:3},{value:"Applying translations",id:"applying-translations",level:3}],u={toc:p},g="wrapper";function c(e){let{components:t,...n}=e;return(0,r.kt)(g,(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"translating"},"Translating"),(0,r.kt)("p",null,"We use ",(0,r.kt)("a",{parentName:"p",href:"https://python-babel.github.io/flask-babel/"},"Flask-Babel")," to translate Superset.\nIn Python files, we use the following\n",(0,r.kt)("a",{parentName:"p",href:"https://python-babel.github.io/flask-babel/#using-translations"},"translation functions"),"\nfrom ",(0,r.kt)("inlineCode",{parentName:"p"},"Flask-Babel"),":"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"gettext")," and ",(0,r.kt)("inlineCode",{parentName:"li"},"lazy_gettext")," (usually aliased to ",(0,r.kt)("inlineCode",{parentName:"li"},"_"),"): for translating singular\nstrings."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"ngettext"),": for translating strings that might become plural.")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-python"},"from flask_babel import lazy_gettext as _\n")),(0,r.kt)("p",null,"then wrap the translatable strings with it, e.g. ",(0,r.kt)("inlineCode",{parentName:"p"},"_('Translate me')"),".\nDuring extraction, string literals passed to ",(0,r.kt)("inlineCode",{parentName:"p"},"_")," will be added to the\ngenerated ",(0,r.kt)("inlineCode",{parentName:"p"},".po")," file for each language for later translation."),(0,r.kt)("p",null,"At runtime, the ",(0,r.kt)("inlineCode",{parentName:"p"},"_")," function will return the translation of the given\nstring for the current language, or the given string itself\nif no translation is available."),(0,r.kt)("p",null,"In TypeScript/JavaScript, the technique is similar:\nwe import ",(0,r.kt)("inlineCode",{parentName:"p"},"t")," (simple translation), ",(0,r.kt)("inlineCode",{parentName:"p"},"tn")," (translation containing a number)."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'import { t, tn } from "@superset-ui/translation";\n')),(0,r.kt)("h3",{id:"enabling-language-selection"},"Enabling language selection"),(0,r.kt)("p",null,"Add the ",(0,r.kt)("inlineCode",{parentName:"p"},"LANGUAGES")," variable to your ",(0,r.kt)("inlineCode",{parentName:"p"},"superset_config.py"),". Having more than one\noption inside will add a language selection dropdown to the UI on the right side\nof the navigation bar."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-python"},"LANGUAGES = {\n 'en': {'flag': 'us', 'name': 'English'},\n 'fr': {'flag': 'fr', 'name': 'French'},\n 'zh': {'flag': 'cn', 'name': 'Chinese'},\n}\n")),(0,r.kt)("h3",{id:"creating-a-new-language-dictionary"},"Creating a new language dictionary"),(0,r.kt)("p",null,"First check if the language code for your target language already exists. Check if the\n",(0,r.kt)("a",{parentName:"p",href:"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes"},"two letter ISO 639-1 code"),"\nfor your target language already exists in the ",(0,r.kt)("inlineCode",{parentName:"p"},"superset/translations")," directory:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},'ls superset/translations | grep -E "^[a-z]{2}\\/"\n')),(0,r.kt)("p",null,"If your language already has a pre-existing translation, skip to the next section"),(0,r.kt)("p",null,"The following languages are already supported by Flask AppBuilder, and will make it\neasier to translate the application to your target language:\n",(0,r.kt)("a",{parentName:"p",href:"https://flask-appbuilder.readthedocs.io/en/latest/i18n.html"},"Flask AppBuilder i18n documentation")),(0,r.kt)("p",null,"To create a dictionary for a new language, first make sure the necessary dependencies are installed:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"pip install -r superset/translations/requirements.txt\n")),(0,r.kt)("p",null,"Then run the following, where ",(0,r.kt)("inlineCode",{parentName:"p"},"LANGUAGE_CODE")," is replaced with the language code for your target\nlanguage:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"pybabel init -i superset/translations/messages.pot -d superset/translations -l LANGUAGE_CODE\n")),(0,r.kt)("p",null,"For instance, to add a translation for Finnish (language code ",(0,r.kt)("inlineCode",{parentName:"p"},"fi"),"), run the following:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"pybabel init -i superset/translations/messages.pot -d superset/translations -l fi\n")),(0,r.kt)("h3",{id:"extracting-new-strings-for-translation"},"Extracting new strings for translation"),(0,r.kt)("p",null,"This step needs to be done every time application strings change. This happens fairly\nfrequently, so if you want to ensure that your translation has good coverage, this\nstep needs to be run fairly frequently and the updated strings merged to the upstream\ncodebase via PRs. To update the template file ",(0,r.kt)("inlineCode",{parentName:"p"},"superset/translations/messages.pot"),"\nwith current application strings, run the following command:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"pybabel extract -F superset/translations/babel.cfg -o superset/translations/messages.pot -k _ -k __ -k t -k tn -k tct .\n")),(0,r.kt)("p",null,"Do not forget to update this file with the appropriate license information."),(0,r.kt)("h3",{id:"updating-language-files"},"Updating language files"),(0,r.kt)("p",null,"Run the following command to update the language files with the new extracted strings."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"}," pybabel update -i superset/translations/messages.pot -d superset/translations --ignore-obsolete\n")),(0,r.kt)("p",null,"You can then translate the strings gathered in files located under\n",(0,r.kt)("inlineCode",{parentName:"p"},"superset/translation"),", where there's one folder per language. You can use ",(0,r.kt)("a",{parentName:"p",href:"https://poedit.net/features"},"Poedit"),"\nto translate the ",(0,r.kt)("inlineCode",{parentName:"p"},"po")," file more conveniently.\nHere is ",(0,r.kt)("a",{parentName:"p",href:"https://web.archive.org/web/20220517065036/https://wiki.lxde.org/en/Translate_*.po_files_with_Poedit"},"a tutorial"),"."),(0,r.kt)("p",null,"To perform the translation on MacOS, you can install ",(0,r.kt)("inlineCode",{parentName:"p"},"poedit")," via Homebrew:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"brew install poedit\n")),(0,r.kt)("p",null,"After this, just start the ",(0,r.kt)("inlineCode",{parentName:"p"},"poedit")," application and open the ",(0,r.kt)("inlineCode",{parentName:"p"},"messages.po")," file. In the\ncase of the Finnish translation, this would be ",(0,r.kt)("inlineCode",{parentName:"p"},"superset/translations/fi/LC_MESSAGES/messages.po"),"."),(0,r.kt)("h3",{id:"applying-translations"},"Applying translations"),(0,r.kt)("p",null,"To make the translations available on the frontend, we need to convert the PO file into\na JSON file. To do this, we need to globally install the npm package ",(0,r.kt)("inlineCode",{parentName:"p"},"po2json"),"."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"npm install -g po2json\n")),(0,r.kt)("p",null,"To convert all PO files to formatted JSON files you can use the ",(0,r.kt)("inlineCode",{parentName:"p"},"po2json.sh")," script."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"./scripts/po2json.sh\n")),(0,r.kt)("p",null,"If you get errors running ",(0,r.kt)("inlineCode",{parentName:"p"},"po2json"),", you might be running the Ubuntu package with the same\nname, rather than the Node.js package (they have a different format for the arguments). If\nthere is a conflict, you may need to update your ",(0,r.kt)("inlineCode",{parentName:"p"},"PATH")," environment variable or fully qualify\nthe executable path (e.g. ",(0,r.kt)("inlineCode",{parentName:"p"},"/usr/local/bin/po2json")," instead of ",(0,r.kt)("inlineCode",{parentName:"p"},"po2json"),").\nIf you get a lot of ",(0,r.kt)("inlineCode",{parentName:"p"},"[null,***]")," in ",(0,r.kt)("inlineCode",{parentName:"p"},"messages.json"),", just delete all the ",(0,r.kt)("inlineCode",{parentName:"p"},"null,"),".\nFor example, ",(0,r.kt)("inlineCode",{parentName:"p"},'"year":["\u5e74"]')," is correct while ",(0,r.kt)("inlineCode",{parentName:"p"},'"year":[null,"\u5e74"]'),"is incorrect."),(0,r.kt)("p",null,"Finally, for the translations to take effect we need to compile translation catalogs into\nbinary MO files."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-bash"},"pybabel compile -d superset/translations\n")))}c.isMDXComponent=!0},3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>m});var a=n(67294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function o(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},i=Object.keys(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},u=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},g="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),g=p(n),d=r,m=g["".concat(s,".").concat(d)]||g[d]||c[d]||i;return n?a.createElement(m,l(l({ref:t},u),{},{components:n})):a.createElement(m,l({ref:t},u))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,l=new Array(i);l[0]=d;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[g]="string"==typeof e?e:r,l[1]=o;for(var p=2;p<i;p++)l[p]=n[p];return a.createElement.apply(null,l)}return a.createElement.apply(null,n)}d.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/67158350.78305603.js b/assets/js/67158350.a3276773.js
similarity index 73%
rename from assets/js/67158350.78305603.js
rename to assets/js/67158350.a3276773.js
index 1ceb3fc..d75fdc3 100644
--- a/assets/js/67158350.78305603.js
+++ b/assets/js/67158350.a3276773.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[674],{78731:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>o,contentTitle:()=>u,default:()=>p,frontMatter:()=>n,metadata:()=>i,toc:()=>l});var a=s(83117),r=(s(67294),s(3905));const n={title:"Issue Codes",sidebar_position:3,version:1},u="Issue Code Reference",i={unversionedId:"miscellaneous/issue-codes",id:"miscellaneous/issue-codes",title:"Issue Codes",description:"This page lists issue codes that may be displayed in",source:"@site/docs/miscellaneous/issue-codes.mdx",sourceDirName:"miscellaneous",slug:"/miscellaneous/issue-codes",permalink:"/docs/miscellaneous/issue-codes",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/miscellaneous/issue-codes.mdx",tags:[],version:"current",sidebarPosition:3,frontMatter:{title:"Issue Codes",sidebar_position:3,version:1},sidebar:"tutorialSidebar",previous:{title:"Importing and Exporting Datasources",permalink:"/docs/miscellaneous/importing-exporting-datasources"},next:{title:"Chart Parameters Reference",permalink:"/docs/miscellaneous/chart-params"}},o={},l=[{value:"Issue 1000",id:"issue-1000",level:2},{value:"Issue 1001",id:"issue-1001",level:2},{value:"Issue 1002",id:"issue-1002",level:2},{value:"Issue 1003",id:"issue-1003",level:2},{value:"Issue 1004",id:"issue-1004",level:2},{value:"Issue 1005",id:"issue-1005",level:2},{value:"Issue 1006",id:"issue-1006",level:2},{value:"Issue 1007",id:"issue-1007",level:2},{value:"Issue 1008",id:"issue-1008",level:2},{value:"Issue 1009",id:"issue-1009",level:2},{value:"Issue 1010",id:"issue-1010",level:2},{value:"Issue 1011",id:"issue-1011",level:2},{value:"Issue 1012",id:"issue-1012",level:2},{value:"Issue 1013",id:"issue-1013",level:2},{value:"Issue 1014",id:"issue-1014",level:2},{value:"Issue 1015",id:"issue-1015",level:2},{value:"Issue 1016",id:"issue-1016",level:2},{value:"Issue 1017",id:"issue-1017",level:2},{value:"Issue 1018",id:"issue-1018",level:2},{value:"Issue 1019",id:"issue-1019",level:2},{value:"Issue 1020",id:"issue-1020",level:2},{value:"Issue 1021",id:"issue-1021",level:2},{value:"Issue 1022",id:"issue-1022",level:2},{value:"Issue 1023",id:"issue-1023",level:2},{value:"Issue 1024",id:"issue-1024",level:2},{value:"Issue 1025",id:"issue-1025",level:2},{value:"Issue 1026",id:"issue-1026",level:2},{value:"Issue 1027",id:"issue-1027",level:2},{value:"Issue 1028",id:"issue-1028",level:2},{value:"Issue 1029",id:"issue-1029",level:2},{value:"Issue 1030",id:"issue-1030",level:2},{value:"Issue 1031",id:"issue-1031",level:2},{value:"Issue 1032",id:"issue-1032",level:2},{value:"Issue 1033",id:"issue-1033",level:2},{value:"Issue 1034",id:"issue-1034",level:2},{value:"Issue 1035",id:"issue-1035",level:2},{value:"Issue 1036",id:"issue-1036",level:2}],d={toc:l},c="wrapper";function p(e){let{components:t,...s}=e;return(0,r.kt)(c,(0,a.Z)({},d,s,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"issue-code-reference"},"Issue Code Reference"),(0,r.kt)("p",null,"This page lists issue codes that may be displayed in\nSuperset and provides additional context."),(0,r.kt)("h2",{id:"issue-1000"},"Issue 1000"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The datasource is too large to query.\n")),(0,r.kt)("p",null,"It's likely your datasource has grown too large to run the current\nquery, and is timing out. You can resolve this by reducing the\nsize of your datasource or by modifying your query to only process a\nsubset of your data."),(0,r.kt)("h2",{id:"issue-1001"},"Issue 1001"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The database is under an unusual load.\n")),(0,r.kt)("p",null,"Your query may have timed out because of unusually high load on the\ndatabase engine. You can make your query simpler, or wait until the\ndatabase is under less load and try again."),(0,r.kt)("h2",{id:"issue-1002"},"Issue 1002"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The database returned an unexpected error.\n")),(0,r.kt)("p",null,"Your query failed because of an error that occurred on the database.\nThis may be due to a syntax error, a bug in your query, or some other\ninternal failure within the database. This is usually not an\nissue within Superset, but instead a problem with the underlying\ndatabase that serves your query."),(0,r.kt)("h2",{id:"issue-1003"},"Issue 1003"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"There is a syntax error in the SQL query. Perhaps there was a misspelling or a typo.\n")),(0,r.kt)("p",null,"Your query failed because of a syntax error within the underlying query. Please\nvalidate that all columns or tables referenced within the query exist and are spelled\ncorrectly."),(0,r.kt)("h2",{id:"issue-1004"},"Issue 1004"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The column was deleted or renamed in the database.\n")),(0,r.kt)("p",null,"Your query failed because it is referencing a column that no longer exists in\nthe underlying datasource. You should modify the query to reference the\nreplacement column, or remove this column from your query."),(0,r.kt)("h2",{id:"issue-1005"},"Issue 1005"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The table was deleted or renamed in the database.\n")),(0,r.kt)("p",null,"Your query failed because it is referencing a table that no longer exists in\nthe underlying database. You should modify your query to reference the correct\ntable."),(0,r.kt)("h2",{id:"issue-1006"},"Issue 1006"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"One or more parameters specified in the query are missing.\n")),(0,r.kt)("p",null,"Your query was not submitted to the database because it's missing one or more\nparameters. You should define all the parameters referenced in the query in a\nvalid JSON document. Check that the parameters are spelled correctly and that\nthe document has a valid syntax."),(0,r.kt)("h2",{id:"issue-1007"},"Issue 1007"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The hostname provided can't be resolved.\n")),(0,r.kt)("p",null,"The hostname provided when adding a new database is invalid and cannot be\nresolved. Please check that there are no typos in the hostname."),(0,r.kt)("h2",{id:"issue-1008"},"Issue 1008"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The port is closed.\n")),(0,r.kt)("p",null,"The port provided when adding a new database is not open. Please check that\nthe port number is correct, and that the database is running and listening on\nthat port."),(0,r.kt)("h2",{id:"issue-1009"},"Issue 1009"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The host might be down, and cannot be reached on the provided port.\n")),(0,r.kt)("p",null,"The host provided when adding a new database doesn't seem to be up.\nAdditionally, it cannot be reached on the provided port. Please check that\nthere are no firewall rules preventing access to the host."),(0,r.kt)("h2",{id:"issue-1010"},"Issue 1010"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Superset encountered an error while running a command.\n")),(0,r.kt)("p",null,"Something unexpected happened, and Superset encountered an error while\nrunning a command. Please reach out to your administrator."),(0,r.kt)("h2",{id:"issue-1011"},"Issue 1011"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Superset encountered an unexpected error.\n")),(0,r.kt)("p",null,"Something unexpected happened in the Superset backend. Please reach out\nto your administrator."),(0,r.kt)("h2",{id:"issue-1012"},"Issue 1012"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The username provided when connecting to a database is not valid.\n")),(0,r.kt)("p",null,"The user provided a username that doesn't exist in the database. Please check\nthat the username is typed correctly and exists in the database."),(0,r.kt)("h2",{id:"issue-1013"},"Issue 1013"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The password provided when connecting to a database is not valid.\n")),(0,r.kt)("p",null,"The user provided a password that is incorrect. Please check that the\npassword is typed correctly."),(0,r.kt)("h2",{id:"issue-1014"},"Issue 1014"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Either the username or the password used are incorrect.\n")),(0,r.kt)("p",null,"Either the username provided does not exist or the password was written incorrectly. Please\ncheck that the username and password were typed correctly."),(0,r.kt)("h2",{id:"issue-1015"},"Issue 1015"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Either the database is spelled incorrectly or does not exist.\n")),(0,r.kt)("p",null,"Either the database was written incorrectly or it does not exist. Check that it was typed correctly."),(0,r.kt)("h2",{id:"issue-1016"},"Issue 1016"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The schema was deleted or renamed in the database.\n")),(0,r.kt)("p",null,"The schema was either removed or renamed. Check that the schema is typed correctly and exists."),(0,r.kt)("h2",{id:"issue-1017"},"Issue 1017"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The user doesn't have the proper permissions to connect to the database\n")),(0,r.kt)("p",null,"We were unable to connect to your database. Please confirm that your service account has the Viewer and Job User roles on the project."),(0,r.kt)("h2",{id:"issue-1018"},"Issue 1018"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"One or more parameters needed to configure a database are missing.\n")),(0,r.kt)("p",null,"Not all parameters required to test, create, or edit a database were present. Please double check which parameters are needed, and that they are present."),(0,r.kt)("h2",{id:"issue-1019"},"Issue 1019"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The submitted payload has the incorrect format.\n")),(0,r.kt)("p",null,"Please check that the request payload has the correct format (eg, JSON)."),(0,r.kt)("h2",{id:"issue-1020"},"Issue 1020"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The submitted payload has the incorrect schema.\n")),(0,r.kt)("p",null,"Please check that the request payload has the expected schema."),(0,r.kt)("h2",{id:"issue-1021"},"Issue 1021"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Results backend needed for asynchronous queries is not configured.\n")),(0,r.kt)("p",null,"Your instance of Superset doesn't have a results backend configured, which is needed for asynchronous queries. Please contact an administrator for further assistance."),(0,r.kt)("h2",{id:"issue-1022"},"Issue 1022"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Database does not allow data manipulation.\n")),(0,r.kt)("p",null,"Only ",(0,r.kt)("inlineCode",{parentName:"p"},"SELECT")," statements are allowed against this database. Please contact an administrator if you need to run DML (data manipulation language) on this database."),(0,r.kt)("h2",{id:"issue-1023"},"Issue 1023"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"CTAS (create table as select) doesn't have a SELECT statement at the end.\n")),(0,r.kt)("p",null,"The last statement in a query run as CTAS (create table as select) MUST be a SELECT statement. Please make sure the last statement in the query is a SELECT."),(0,r.kt)("h2",{id:"issue-1024"},"Issue 1024"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"CVAS (create view as select) query has more than one statement.\n")),(0,r.kt)("p",null,"When running a CVAS (create view as select) the query should have a single statement. Please make sure the query has a single statement, and no extra semi-colons other than the last one."),(0,r.kt)("h2",{id:"issue-1025"},"Issue 1025"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"CVAS (create view as select) query is not a SELECT statement.\n")),(0,r.kt)("p",null,"When running a CVAS (create view as select) the query should be a SELECT statement. Please make sure the query has a single statement and it's a SELECT statement."),(0,r.kt)("h2",{id:"issue-1026"},"Issue 1026"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Query is too complex and takes too long to run.\n")),(0,r.kt)("p",null,"The submitted query might be too complex to run under the time limit defined by your Superset administrator. Please double check your query and verify if it can be optimized. Alternatively, contact your administrator to increase the timeout period."),(0,r.kt)("h2",{id:"issue-1027"},"Issue 1027"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The database is currently running too many queries.\n")),(0,r.kt)("p",null,"The database might be under heavy load, running too many queries. Please try again later, or contact an administrator for further assistance."),(0,r.kt)("h2",{id:"issue-1028"},"Issue 1028"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"One or more parameters specified in the query are malformatted.\n")),(0,r.kt)("p",null,'The query contains one or more malformed template parameters. Please check your query and confirm that all template parameters are surround by double braces, for example, "{{ ds }}". Then, try running your query again.'),(0,r.kt)("h2",{id:"issue-1029"},"Issue 1029"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The object does not exist in this database.\n")),(0,r.kt)("p",null,"Either the schema, column, or table do not exist in the database."),(0,r.kt)("h2",{id:"issue-1030"},"Issue 1030"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The query potentially has a syntax error.\n")),(0,r.kt)("p",null,"The query might have a syntax error. Please check and run again."),(0,r.kt)("h2",{id:"issue-1031"},"Issue 1031"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The results backend no longer has the data from the query.\n")),(0,r.kt)("p",null,"The results from the query might have been deleted from the results backend after some period. Please re-run your query."),(0,r.kt)("h2",{id:"issue-1032"},"Issue 1032"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The query associated with the results was deleted.\n")),(0,r.kt)("p",null,"The query associated with the stored results no longer exists. Please re-run your query."),(0,r.kt)("h2",{id:"issue-1033"},"Issue 1033"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The results stored in the backend were stored in a different format, and no longer can be deserialized.\n")),(0,r.kt)("p",null,"The query results were stored in a format that is no longer supported. Please re-run your query."),(0,r.kt)("h2",{id:"issue-1034"},"Issue 1034"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The database port provided is invalid.\n")),(0,r.kt)("p",null,"Please check that the provided database port is an integer between 0 and 65535 (inclusive)."),(0,r.kt)("h2",{id:"issue-1035"},"Issue 1035"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Failed to start remote query on a worker.\n")),(0,r.kt)("p",null,"The query was not started by an asynchronous worker. Please reach out to your administrator for further assistance."),(0,r.kt)("h2",{id:"issue-1036"},"Issue 1036"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The database was deleted.\n")),(0,r.kt)("p",null,"The operation failed because the database referenced no longer exists. Please reach out to your administrator for further assistance."))}p.isMDXComponent=!0},3905:(e,t,s)=>{s.d(t,{Zo:()=>d,kt:()=>m});var a=s(67294);function r(e,t,s){return t in e?Object.defineProperty(e,t,{value:s,enumerable:!0,configurable:!0,writable:!0}):e[t]=s,e}function n(e,t){var s=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),s.push.apply(s,a)}return s}function u(e){for(var t=1;t<arguments.length;t++){var s=null!=arguments[t]?arguments[t]:{};t%2?n(Object(s),!0).forEach((function(t){r(e,t,s[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(s)):n(Object(s)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(s,t))}))}return e}function i(e,t){if(null==e)return{};var s,a,r=function(e,t){if(null==e)return{};var s,a,r={},n=Object.keys(e);for(a=0;a<n.length;a++)s=n[a],t.indexOf(s)>=0||(r[s]=e[s]);return r}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(a=0;a<n.length;a++)s=n[a],t.indexOf(s)>=0||Object.prototype.propertyIsEnumerable.call(e,s)&&(r[s]=e[s])}return r}var o=a.createContext({}),l=function(e){var t=a.useContext(o),s=t;return e&&(s="function"==typeof e?e(t):u(u({},t),e)),s},d=function(e){var t=l(e.components);return a.createElement(o.Provider,{value:t},e.children)},c="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var s=e.components,r=e.mdxType,n=e.originalType,o=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),c=l(s),h=r,m=c["".concat(o,".").concat(h)]||c[h]||p[h]||n;return s?a.createElement(m,u(u({ref:t},d),{},{components:s})):a.createElement(m,u({ref:t},d))}));function m(e,t){var s=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var n=s.length,u=new Array(n);u[0]=h;var i={};for(var o in t)hasOwnProperty.call(t,o)&&(i[o]=t[o]);i.originalType=e,i[c]="string"==typeof e?e:r,u[1]=i;for(var l=2;l<n;l++)u[l]=s[l];return a.createElement.apply(null,u)}return a.createElement.apply(null,s)}h.displayName="MDXCreateElement"}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[674],{78731:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>o,contentTitle:()=>u,default:()=>p,frontMatter:()=>n,metadata:()=>i,toc:()=>l});var a=s(83117),r=(s(67294),s(3905));const n={title:"Issue Codes",sidebar_position:3,version:1},u="Issue Code Reference",i={unversionedId:"miscellaneous/issue-codes",id:"miscellaneous/issue-codes",title:"Issue Codes",description:"This page lists issue codes that may be displayed in",source:"@site/docs/miscellaneous/issue-codes.mdx",sourceDirName:"miscellaneous",slug:"/miscellaneous/issue-codes",permalink:"/docs/miscellaneous/issue-codes",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/miscellaneous/issue-codes.mdx",tags:[],version:"current",sidebarPosition:3,frontMatter:{title:"Issue Codes",sidebar_position:3,version:1},sidebar:"tutorialSidebar",previous:{title:"Importing and Exporting Datasources",permalink:"/docs/miscellaneous/importing-exporting-datasources"},next:{title:"Chart Parameters Reference",permalink:"/docs/miscellaneous/chart-params"}},o={},l=[{value:"Issue 1000",id:"issue-1000",level:2},{value:"Issue 1001",id:"issue-1001",level:2},{value:"Issue 1002",id:"issue-1002",level:2},{value:"Issue 1003",id:"issue-1003",level:2},{value:"Issue 1004",id:"issue-1004",level:2},{value:"Issue 1005",id:"issue-1005",level:2},{value:"Issue 1006",id:"issue-1006",level:2},{value:"Issue 1007",id:"issue-1007",level:2},{value:"Issue 1008",id:"issue-1008",level:2},{value:"Issue 1009",id:"issue-1009",level:2},{value:"Issue 1010",id:"issue-1010",level:2},{value:"Issue 1011",id:"issue-1011",level:2},{value:"Issue 1012",id:"issue-1012",level:2},{value:"Issue 1013",id:"issue-1013",level:2},{value:"Issue 1014",id:"issue-1014",level:2},{value:"Issue 1015",id:"issue-1015",level:2},{value:"Issue 1016",id:"issue-1016",level:2},{value:"Issue 1017",id:"issue-1017",level:2},{value:"Issue 1018",id:"issue-1018",level:2},{value:"Issue 1019",id:"issue-1019",level:2},{value:"Issue 1020",id:"issue-1020",level:2},{value:"Issue 1021",id:"issue-1021",level:2},{value:"Issue 1022",id:"issue-1022",level:2},{value:"Issue 1023",id:"issue-1023",level:2},{value:"Issue 1024",id:"issue-1024",level:2},{value:"Issue 1025",id:"issue-1025",level:2},{value:"Issue 1026",id:"issue-1026",level:2},{value:"Issue 1027",id:"issue-1027",level:2},{value:"Issue 1028",id:"issue-1028",level:2},{value:"Issue 1029",id:"issue-1029",level:2},{value:"Issue 1030",id:"issue-1030",level:2},{value:"Issue 1031",id:"issue-1031",level:2},{value:"Issue 1032",id:"issue-1032",level:2},{value:"Issue 1033",id:"issue-1033",level:2},{value:"Issue 1034",id:"issue-1034",level:2},{value:"Issue 1035",id:"issue-1035",level:2},{value:"Issue 1036",id:"issue-1036",level:2}],d={toc:l},c="wrapper";function p(e){let{components:t,...s}=e;return(0,r.kt)(c,(0,a.Z)({},d,s,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"issue-code-reference"},"Issue Code Reference"),(0,r.kt)("p",null,"This page lists issue codes that may be displayed in\nSuperset and provides additional context."),(0,r.kt)("h2",{id:"issue-1000"},"Issue 1000"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The datasource is too large to query.\n")),(0,r.kt)("p",null,"It's likely your datasource has grown too large to run the current\nquery, and is timing out. You can resolve this by reducing the\nsize of your datasource or by modifying your query to only process a\nsubset of your data."),(0,r.kt)("h2",{id:"issue-1001"},"Issue 1001"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The database is under an unusual load.\n")),(0,r.kt)("p",null,"Your query may have timed out because of unusually high load on the\ndatabase engine. You can make your query simpler, or wait until the\ndatabase is under less load and try again."),(0,r.kt)("h2",{id:"issue-1002"},"Issue 1002"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The database returned an unexpected error.\n")),(0,r.kt)("p",null,"Your query failed because of an error that occurred on the database.\nThis may be due to a syntax error, a bug in your query, or some other\ninternal failure within the database. This is usually not an\nissue within Superset, but instead a problem with the underlying\ndatabase that serves your query."),(0,r.kt)("h2",{id:"issue-1003"},"Issue 1003"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"There is a syntax error in the SQL query. Perhaps there was a misspelling or a typo.\n")),(0,r.kt)("p",null,"Your query failed because of a syntax error within the underlying query. Please\nvalidate that all columns or tables referenced within the query exist and are spelled\ncorrectly."),(0,r.kt)("h2",{id:"issue-1004"},"Issue 1004"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The column was deleted or renamed in the database.\n")),(0,r.kt)("p",null,"Your query failed because it is referencing a column that no longer exists in\nthe underlying datasource. You should modify the query to reference the\nreplacement column, or remove this column from your query."),(0,r.kt)("h2",{id:"issue-1005"},"Issue 1005"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The table was deleted or renamed in the database.\n")),(0,r.kt)("p",null,"Your query failed because it is referencing a table that no longer exists in\nthe underlying database. You should modify your query to reference the correct\ntable."),(0,r.kt)("h2",{id:"issue-1006"},"Issue 1006"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"One or more parameters specified in the query are missing.\n")),(0,r.kt)("p",null,"Your query was not submitted to the database because it's missing one or more\nparameters. You should define all the parameters referenced in the query in a\nvalid JSON document. Check that the parameters are spelled correctly and that\nthe document has a valid syntax."),(0,r.kt)("h2",{id:"issue-1007"},"Issue 1007"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The hostname provided can't be resolved.\n")),(0,r.kt)("p",null,"The hostname provided when adding a new database is invalid and cannot be\nresolved. Please check that there are no typos in the hostname."),(0,r.kt)("h2",{id:"issue-1008"},"Issue 1008"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The port is closed.\n")),(0,r.kt)("p",null,"The port provided when adding a new database is not open. Please check that\nthe port number is correct, and that the database is running and listening on\nthat port."),(0,r.kt)("h2",{id:"issue-1009"},"Issue 1009"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The host might be down, and cannot be reached on the provided port.\n")),(0,r.kt)("p",null,"The host provided when adding a new database doesn't seem to be up.\nAdditionally, it cannot be reached on the provided port. Please check that\nthere are no firewall rules preventing access to the host."),(0,r.kt)("h2",{id:"issue-1010"},"Issue 1010"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Superset encountered an error while running a command.\n")),(0,r.kt)("p",null,"Something unexpected happened, and Superset encountered an error while\nrunning a command. Please reach out to your administrator."),(0,r.kt)("h2",{id:"issue-1011"},"Issue 1011"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Superset encountered an unexpected error.\n")),(0,r.kt)("p",null,"Something unexpected happened in the Superset backend. Please reach out\nto your administrator."),(0,r.kt)("h2",{id:"issue-1012"},"Issue 1012"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The username provided when connecting to a database is not valid.\n")),(0,r.kt)("p",null,"The user provided a username that doesn't exist in the database. Please check\nthat the username is typed correctly and exists in the database."),(0,r.kt)("h2",{id:"issue-1013"},"Issue 1013"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The password provided when connecting to a database is not valid.\n")),(0,r.kt)("p",null,"The user provided a password that is incorrect. Please check that the\npassword is typed correctly."),(0,r.kt)("h2",{id:"issue-1014"},"Issue 1014"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Either the username or the password used are incorrect.\n")),(0,r.kt)("p",null,"Either the username provided does not exist or the password was written incorrectly. Please\ncheck that the username and password were typed correctly."),(0,r.kt)("h2",{id:"issue-1015"},"Issue 1015"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Either the database is spelled incorrectly or does not exist.\n")),(0,r.kt)("p",null,"Either the database was written incorrectly or it does not exist. Check that it was typed correctly."),(0,r.kt)("h2",{id:"issue-1016"},"Issue 1016"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The schema was deleted or renamed in the database.\n")),(0,r.kt)("p",null,"The schema was either removed or renamed. Check that the schema is typed correctly and exists."),(0,r.kt)("h2",{id:"issue-1017"},"Issue 1017"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The user doesn't have the proper permissions to connect to the database\n")),(0,r.kt)("p",null,"We were unable to connect to your database. Please confirm that your service account has the Viewer and Job User roles on the project."),(0,r.kt)("h2",{id:"issue-1018"},"Issue 1018"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"One or more parameters needed to configure a database are missing.\n")),(0,r.kt)("p",null,"Not all parameters required to test, create, or edit a database were present. Please double check which parameters are needed, and that they are present."),(0,r.kt)("h2",{id:"issue-1019"},"Issue 1019"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The submitted payload has the incorrect format.\n")),(0,r.kt)("p",null,"Please check that the request payload has the correct format (eg, JSON)."),(0,r.kt)("h2",{id:"issue-1020"},"Issue 1020"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The submitted payload has the incorrect schema.\n")),(0,r.kt)("p",null,"Please check that the request payload has the expected schema."),(0,r.kt)("h2",{id:"issue-1021"},"Issue 1021"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Results backend needed for asynchronous queries is not configured.\n")),(0,r.kt)("p",null,"Your instance of Superset doesn't have a results backend configured, which is needed for asynchronous queries. Please contact an administrator for further assistance."),(0,r.kt)("h2",{id:"issue-1022"},"Issue 1022"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Database does not allow data manipulation.\n")),(0,r.kt)("p",null,"Only ",(0,r.kt)("inlineCode",{parentName:"p"},"SELECT")," statements are allowed against this database. Please contact an administrator if you need to run DML (data manipulation language) on this database."),(0,r.kt)("h2",{id:"issue-1023"},"Issue 1023"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"CTAS (create table as select) doesn't have a SELECT statement at the end.\n")),(0,r.kt)("p",null,"The last statement in a query run as CTAS (create table as select) MUST be a SELECT statement. Please make sure the last statement in the query is a SELECT."),(0,r.kt)("h2",{id:"issue-1024"},"Issue 1024"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"CVAS (create view as select) query has more than one statement.\n")),(0,r.kt)("p",null,"When running a CVAS (create view as select) the query should have a single statement. Please make sure the query has a single statement, and no extra semi-colons other than the last one."),(0,r.kt)("h2",{id:"issue-1025"},"Issue 1025"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"CVAS (create view as select) query is not a SELECT statement.\n")),(0,r.kt)("p",null,"When running a CVAS (create view as select) the query should be a SELECT statement. Please make sure the query has a single statement and it's a SELECT statement."),(0,r.kt)("h2",{id:"issue-1026"},"Issue 1026"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Query is too complex and takes too long to run.\n")),(0,r.kt)("p",null,"The submitted query might be too complex to run under the time limit defined by your Superset administrator. Please double check your query and verify if it can be optimized. Alternatively, contact your administrator to increase the timeout period."),(0,r.kt)("h2",{id:"issue-1027"},"Issue 1027"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The database is currently running too many queries.\n")),(0,r.kt)("p",null,"The database might be under heavy load, running too many queries. Please try again later, or contact an administrator for further assistance."),(0,r.kt)("h2",{id:"issue-1028"},"Issue 1028"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"One or more parameters specified in the query are malformed.\n")),(0,r.kt)("p",null,'The query contains one or more malformed template parameters. Please check your query and confirm that all template parameters are surround by double braces, for example, "{{ ds }}". Then, try running your query again.'),(0,r.kt)("h2",{id:"issue-1029"},"Issue 1029"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The object does not exist in this database.\n")),(0,r.kt)("p",null,"Either the schema, column, or table do not exist in the database."),(0,r.kt)("h2",{id:"issue-1030"},"Issue 1030"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The query potentially has a syntax error.\n")),(0,r.kt)("p",null,"The query might have a syntax error. Please check and run again."),(0,r.kt)("h2",{id:"issue-1031"},"Issue 1031"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The results backend no longer has the data from the query.\n")),(0,r.kt)("p",null,"The results from the query might have been deleted from the results backend after some period. Please re-run your query."),(0,r.kt)("h2",{id:"issue-1032"},"Issue 1032"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The query associated with the results was deleted.\n")),(0,r.kt)("p",null,"The query associated with the stored results no longer exists. Please re-run your query."),(0,r.kt)("h2",{id:"issue-1033"},"Issue 1033"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The results stored in the backend were stored in a different format, and no longer can be deserialized.\n")),(0,r.kt)("p",null,"The query results were stored in a format that is no longer supported. Please re-run your query."),(0,r.kt)("h2",{id:"issue-1034"},"Issue 1034"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The database port provided is invalid.\n")),(0,r.kt)("p",null,"Please check that the provided database port is an integer between 0 and 65535 (inclusive)."),(0,r.kt)("h2",{id:"issue-1035"},"Issue 1035"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"Failed to start remote query on a worker.\n")),(0,r.kt)("p",null,"The query was not started by an asynchronous worker. Please reach out to your administrator for further assistance."),(0,r.kt)("h2",{id:"issue-1036"},"Issue 1036"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre"},"The database was deleted.\n")),(0,r.kt)("p",null,"The operation failed because the database referenced no longer exists. Please reach out to your administrator for further assistance."))}p.isMDXComponent=!0},3905:(e,t,s)=>{s.d(t,{Zo:()=>d,kt:()=>m});var a=s(67294);function r(e,t,s){return t in e?Object.defineProperty(e,t,{value:s,enumerable:!0,configurable:!0,writable:!0}):e[t]=s,e}function n(e,t){var s=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),s.push.apply(s,a)}return s}function u(e){for(var t=1;t<arguments.length;t++){var s=null!=arguments[t]?arguments[t]:{};t%2?n(Object(s),!0).forEach((function(t){r(e,t,s[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(s)):n(Object(s)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(s,t))}))}return e}function i(e,t){if(null==e)return{};var s,a,r=function(e,t){if(null==e)return{};var s,a,r={},n=Object.keys(e);for(a=0;a<n.length;a++)s=n[a],t.indexOf(s)>=0||(r[s]=e[s]);return r}(e,t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);for(a=0;a<n.length;a++)s=n[a],t.indexOf(s)>=0||Object.prototype.propertyIsEnumerable.call(e,s)&&(r[s]=e[s])}return r}var o=a.createContext({}),l=function(e){var t=a.useContext(o),s=t;return e&&(s="function"==typeof e?e(t):u(u({},t),e)),s},d=function(e){var t=l(e.components);return a.createElement(o.Provider,{value:t},e.children)},c="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},h=a.forwardRef((function(e,t){var s=e.components,r=e.mdxType,n=e.originalType,o=e.parentName,d=i(e,["components","mdxType","originalType","parentName"]),c=l(s),h=r,m=c["".concat(o,".").concat(h)]||c[h]||p[h]||n;return s?a.createElement(m,u(u({ref:t},d),{},{components:s})):a.createElement(m,u({ref:t},d))}));function m(e,t){var s=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var n=s.length,u=new Array(n);u[0]=h;var i={};for(var o in t)hasOwnProperty.call(t,o)&&(i[o]=t[o]);i.originalType=e,i[c]="string"==typeof e?e:r,u[1]=i;for(var l=2;l<n;l++)u[l]=s[l];return a.createElement.apply(null,u)}return a.createElement.apply(null,s)}h.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/6948bca1.88386997.js b/assets/js/6948bca1.cde86692.js
similarity index 60%
rename from assets/js/6948bca1.88386997.js
rename to assets/js/6948bca1.cde86692.js
index d7036a2..b6c2820 100644
--- a/assets/js/6948bca1.88386997.js
+++ b/assets/js/6948bca1.cde86692.js
@@ -1 +1 @@
-"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[6552],{6882:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=n(83117),o=(n(67294),n(3905));const i={title:"Types of Contributions",hide_title:!0,sidebar_position:2,version:1},a=void 0,s={unversionedId:"contributing/types-of-contributions",id:"contributing/types-of-contributions",title:"Types of Contributions",description:"Types of Contributions",source:"@site/docs/contributing/types-of-contributions.mdx",sourceDirName:"contributing",slug:"/contributing/types-of-contributions",permalink:"/docs/contributing/types-of-contributions",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/contributing/types-of-contributions.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{title:"Types of Contributions",hide_title:!0,sidebar_position:2,version:1},sidebar:"tutorialSidebar",previous:{title:"Contributing to Superset",permalink:"/docs/contributing/contributing-page"},next:{title:"Pull Request Guidelines",permalink:"/docs/contributing/pull-request-guidelines"}},u={},l=[{value:"Types of Contributions",id:"types-of-contributions",level:2},{value:"Report Bug",id:"report-bug",level:3},{value:"Submit Ideas or Feature Requests",id:"submit-ideas-or-feature-requests",level:3},{value:"Fix Bugs",id:"fix-bugs",level:3},{value:"Implement Features",id:"implement-features",level:3},{value:"Improve Documentation",id:"improve-documentation",level:3},{value:"Add Translations",id:"add-translations",level:3},{value:"Ask Questions",id:"ask-questions",level:3}],p={toc:l},c="wrapper";function d(e){let{components:t,...n}=e;return(0,o.kt)(c,(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"types-of-contributions"},"Types of Contributions"),(0,o.kt)("h3",{id:"report-bug"},"Report Bug"),(0,o.kt)("p",null,"The best way to report a bug is to file an issue on GitHub. Please include:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Your operating system name and version."),(0,o.kt)("li",{parentName:"ul"},"Superset version."),(0,o.kt)("li",{parentName:"ul"},"Detailed steps to reproduce the bug."),(0,o.kt)("li",{parentName:"ul"},"Any details about your local setup that might be helpful in troubleshooting.")),(0,o.kt)("p",null,"When posting Python stack traces, please quote them using\n",(0,o.kt)("a",{parentName:"p",href:"https://help.github.com/articles/creating-and-highlighting-code-blocks/"},"Markdown blocks"),"."),(0,o.kt)("p",null,(0,o.kt)("em",{parentName:"p"},"Please note that feature requests opened as Github Issues will be moved to Discussions.")),(0,o.kt)("h3",{id:"submit-ideas-or-feature-requests"},"Submit Ideas or Feature Requests"),(0,o.kt)("p",null,"The best way is to start an ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/apache/superset/discussions/categories/ideas"},'"Ideas" Discussion thread')," on GitHub:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Explain in detail how it would work."),(0,o.kt)("li",{parentName:"ul"},"Keep the scope as narrow as possible, to make it easier to implement."),(0,o.kt)("li",{parentName:"ul"},"Remember that this is a volunteer-driven project, and that your contributions are as welcome as anyone's :)")),(0,o.kt)("p",null,"To propose large features or major changes to codebase, and help usher in those changes, please create a ",(0,o.kt)("strong",{parentName:"p"},"Superset Improvement Proposal (SIP)"),". See template from ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/apache/superset/issues/5602"},"SIP-0")),(0,o.kt)("h3",{id:"fix-bugs"},"Fix Bugs"),(0,o.kt)("p",null,"Look through the GitHub issues. Issues tagged with ",(0,o.kt)("inlineCode",{parentName:"p"},"#bug")," are\nopen to whoever wants to implement them."),(0,o.kt)("h3",{id:"implement-features"},"Implement Features"),(0,o.kt)("p",null,"Look through the GitHub issues. Issues tagged with\n",(0,o.kt)("inlineCode",{parentName:"p"},"#feature")," is open to whoever wants to implement it."),(0,o.kt)("h3",{id:"improve-documentation"},"Improve Documentation"),(0,o.kt)("p",null,"Superset could always use better documentation,\nwhether as part of the official Superset docs,\nin docstrings, ",(0,o.kt)("inlineCode",{parentName:"p"},"docs/*.rst")," or even on the web as blog posts or\narticles. See ",(0,o.kt)("a",{parentName:"p",href:"#documentation"},"Documentation")," for more details."),(0,o.kt)("h3",{id:"add-translations"},"Add Translations"),(0,o.kt)("p",null,"If you are proficient in a non-English language, you can help translate\ntext strings from Superset's UI. You can jump in to the existing\nlanguage dictionaries at\n",(0,o.kt)("inlineCode",{parentName:"p"},"superset/translations/<language_code>/LC_MESSAGES/messages.po"),", or\neven create a dictionary for a new language altogether.\nSee ",(0,o.kt)("a",{parentName:"p",href:"#translating"},"Translating")," for more details."),(0,o.kt)("h3",{id:"ask-questions"},"Ask Questions"),(0,o.kt)("p",null,"There is a dedicated ",(0,o.kt)("a",{parentName:"p",href:"https://stackoverflow.com/questions/tagged/apache-superset"},(0,o.kt)("inlineCode",{parentName:"a"},"apache-superset")," tag")," on ",(0,o.kt)("a",{parentName:"p",href:"https://stackoverflow.com/"},"StackOverflow"),". Please use it when asking questions."))}d.isMDXComponent=!0},3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,r,o=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var u=r.createContext({}),l=function(e){var t=r.useContext(u),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},p=function(e){var t=l(e.components);return r.createElement(u.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,u=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),c=l(n),m=o,h=c["".concat(u,".").concat(m)]||c[m]||d[m]||i;return n?r.createElement(h,a(a({ref:t},p),{},{components:n})):r.createElement(h,a({ref:t},p))}));function h(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=m;var s={};for(var u in t)hasOwnProperty.call(t,u)&&(s[u]=t[u]);s.originalType=e,s[c]="string"==typeof e?e:o,a[1]=s;for(var l=2;l<i;l++)a[l]=n[l];return r.createElement.apply(null,a)}return r.createElement.apply(null,n)}m.displayName="MDXCreateElement"}}]);
\ No newline at end of file
+"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[6552],{6882:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>a,default:()=>d,frontMatter:()=>i,metadata:()=>s,toc:()=>l});var r=n(83117),o=(n(67294),n(3905));const i={title:"Types of Contributions",hide_title:!0,sidebar_position:2,version:1},a=void 0,s={unversionedId:"contributing/types-of-contributions",id:"contributing/types-of-contributions",title:"Types of Contributions",description:"Types of Contributions",source:"@site/docs/contributing/types-of-contributions.mdx",sourceDirName:"contributing",slug:"/contributing/types-of-contributions",permalink:"/docs/contributing/types-of-contributions",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/contributing/types-of-contributions.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{title:"Types of Contributions",hide_title:!0,sidebar_position:2,version:1},sidebar:"tutorialSidebar",previous:{title:"Contributing to Superset",permalink:"/docs/contributing/contributing-page"},next:{title:"Pull Request Guidelines",permalink:"/docs/contributing/pull-request-guidelines"}},u={},l=[{value:"Types of Contributions",id:"types-of-contributions",level:2},{value:"Report Bug",id:"report-bug",level:3},{value:"Submit Ideas or Feature Requests",id:"submit-ideas-or-feature-requests",level:3},{value:"Fix Bugs",id:"fix-bugs",level:3},{value:"Implement Features",id:"implement-features",level:3},{value:"Improve Documentation",id:"improve-documentation",level:3},{value:"Add Translations",id:"add-translations",level:3},{value:"Ask Questions",id:"ask-questions",level:3}],p={toc:l},c="wrapper";function d(e){let{components:t,...n}=e;return(0,o.kt)(c,(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h2",{id:"types-of-contributions"},"Types of Contributions"),(0,o.kt)("h3",{id:"report-bug"},"Report Bug"),(0,o.kt)("p",null,"The best way to report a bug is to file an issue on GitHub. Please include:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Your operating system name and version."),(0,o.kt)("li",{parentName:"ul"},"Superset version."),(0,o.kt)("li",{parentName:"ul"},"Detailed steps to reproduce the bug."),(0,o.kt)("li",{parentName:"ul"},"Any details about your local setup that might be helpful in troubleshooting.")),(0,o.kt)("p",null,"When posting Python stack traces, please quote them using\n",(0,o.kt)("a",{parentName:"p",href:"https://help.github.com/articles/creating-and-highlighting-code-blocks/"},"Markdown blocks"),"."),(0,o.kt)("p",null,(0,o.kt)("em",{parentName:"p"},"Please note that feature requests opened as GitHub Issues will be moved to Discussions.")),(0,o.kt)("h3",{id:"submit-ideas-or-feature-requests"},"Submit Ideas or Feature Requests"),(0,o.kt)("p",null,"The best way is to start an ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/apache/superset/discussions/categories/ideas"},'"Ideas" Discussion thread')," on GitHub:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Explain in detail how it would work."),(0,o.kt)("li",{parentName:"ul"},"Keep the scope as narrow as possible, to make it easier to implement."),(0,o.kt)("li",{parentName:"ul"},"Remember that this is a volunteer-driven project, and that your contributions are as welcome as anyone's :)")),(0,o.kt)("p",null,"To propose large features or major changes to codebase, and help usher in those changes, please create a ",(0,o.kt)("strong",{parentName:"p"},"Superset Improvement Proposal (SIP)"),". See template from ",(0,o.kt)("a",{parentName:"p",href:"https://github.com/apache/superset/issues/5602"},"SIP-0")),(0,o.kt)("h3",{id:"fix-bugs"},"Fix Bugs"),(0,o.kt)("p",null,"Look through the GitHub issues. Issues tagged with ",(0,o.kt)("inlineCode",{parentName:"p"},"#bug")," are\nopen to whoever wants to implement them."),(0,o.kt)("h3",{id:"implement-features"},"Implement Features"),(0,o.kt)("p",null,"Look through the GitHub issues. Issues tagged with\n",(0,o.kt)("inlineCode",{parentName:"p"},"#feature")," is open to whoever wants to implement it."),(0,o.kt)("h3",{id:"improve-documentation"},"Improve Documentation"),(0,o.kt)("p",null,"Superset could always use better documentation,\nwhether as part of the official Superset docs,\nin docstrings, ",(0,o.kt)("inlineCode",{parentName:"p"},"docs/*.rst")," or even on the web as blog posts or\narticles. See ",(0,o.kt)("a",{parentName:"p",href:"#documentation"},"Documentation")," for more details."),(0,o.kt)("h3",{id:"add-translations"},"Add Translations"),(0,o.kt)("p",null,"If you are proficient in a non-English language, you can help translate\ntext strings from Superset's UI. You can jump into the existing\nlanguage dictionaries at\n",(0,o.kt)("inlineCode",{parentName:"p"},"superset/translations/<language_code>/LC_MESSAGES/messages.po"),", or\neven create a dictionary for a new language altogether.\nSee ",(0,o.kt)("a",{parentName:"p",href:"#translating"},"Translating")," for more details."),(0,o.kt)("h3",{id:"ask-questions"},"Ask Questions"),(0,o.kt)("p",null,"There is a dedicated ",(0,o.kt)("a",{parentName:"p",href:"https://stackoverflow.com/questions/tagged/apache-superset"},(0,o.kt)("inlineCode",{parentName:"a"},"apache-superset")," tag")," on ",(0,o.kt)("a",{parentName:"p",href:"https://stackoverflow.com/"},"StackOverflow"),". Please use it when asking questions."))}d.isMDXComponent=!0},3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>b});var r=n(67294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){o(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,r,o=function(e,t){if(null==e)return{};var n,r,o={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var u=r.createContext({}),l=function(e){var t=r.useContext(u),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},p=function(e){var t=l(e.components);return r.createElement(u.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,u=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),c=l(n),m=o,b=c["".concat(u,".").concat(m)]||c[m]||d[m]||i;return n?r.createElement(b,a(a({ref:t},p),{},{components:n})):r.createElement(b,a({ref:t},p))}));function b(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,a=new Array(i);a[0]=m;var s={};for(var u in t)hasOwnProperty.call(t,u)&&(s[u]=t[u]);s.originalType=e,s[c]="string"==typeof e?e:o,a[1]=s;for(var l=2;l<i;l++)a[l]=n[l];return r.createElement.apply(null,a)}return r.createElement.apply(null,n)}m.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/6edc47f3.74bc8988.js b/assets/js/6edc47f3.74bc8988.js
new file mode 100644
index 0000000..f4b5082
--- /dev/null
+++ b/assets/js/6edc47f3.74bc8988.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[1533],{72883:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var r=n(83117),a=(n(67294),n(3905));const i={title:"Setup SSH Tunneling",hide_title:!0,sidebar_position:12,version:1},l=void 0,o={unversionedId:"installation/setup-ssh-tunneling",id:"installation/setup-ssh-tunneling",title:"Setup SSH Tunneling",description:"SSH Tunneling",source:"@site/docs/installation/setup-ssh-tunneling.mdx",sourceDirName:"installation",slug:"/installation/setup-ssh-tunneling",permalink:"/docs/installation/setup-ssh-tunneling",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/installation/setup-ssh-tunneling.mdx",tags:[],version:"current",sidebarPosition:12,frontMatter:{title:"Setup SSH Tunneling",hide_title:!0,sidebar_position:12,version:1},sidebar:"tutorialSidebar",previous:{title:"SQL Templating",permalink:"/docs/installation/sql-templating"},next:{title:"Installing Database Drivers",permalink:"/docs/databases/installing-database-drivers"}},s={},u=[{value:"SSH Tunneling",id:"ssh-tunneling",level:2}],p={toc:u},c="wrapper";function d(e){let{components:t,...n}=e;return(0,a.kt)(c,(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"ssh-tunneling"},"SSH Tunneling"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Turn on feature flag"),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Change ",(0,a.kt)("a",{parentName:"li",href:"https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L489"},(0,a.kt)("inlineCode",{parentName:"a"},"SSH_TUNNELING"))," to ",(0,a.kt)("inlineCode",{parentName:"li"},"True")),(0,a.kt)("li",{parentName:"ul"},"If you want to add more security when establishing the tunnel we allow users to overwrite the ",(0,a.kt)("inlineCode",{parentName:"li"},"SSHTunnelManager")," class ",(0,a.kt)("a",{parentName:"li",href:"https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L507"},"here")),(0,a.kt)("li",{parentName:"ul"},"You can also set the ",(0,a.kt)("a",{parentName:"li",href:"https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L508"},(0,a.kt)("inlineCode",{parentName:"a"},"SSH_TUNNEL_LOCAL_BIND_ADDRESS"))," this the host address where the tunnel will be accessible on your VPC"))),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Create database w/ ssh tunnel enabled"),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"With the feature flag enabled you should now see ssh tunnel toggle."),(0,a.kt)("li",{parentName:"ul"},"Click the toggle to enables ssh tunneling and add your credentials accordingly.",(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Superset allows for 2 different type authentication (Basic + Private Key). These credentials should come from your service provider."))))),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Verify data is flowing"),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Once SSH tunneling has been enabled, go to SQL Lab and write a query to verify data is properly flowing.")))))}d.isMDXComponent=!0},3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function o(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),u=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),c=u(n),f=a,m=c["".concat(s,".").concat(f)]||c[f]||d[f]||i;return n?r.createElement(m,l(l({ref:t},p),{},{components:n})):r.createElement(m,l({ref:t},p))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=f;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[c]="string"==typeof e?e:a,l[1]=o;for(var u=2;u<i;u++)l[u]=n[u];return r.createElement.apply(null,l)}return r.createElement.apply(null,n)}f.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/6edc47f3.f737762f.js b/assets/js/6edc47f3.f737762f.js
deleted file mode 100644
index 0efd240..0000000
--- a/assets/js/6edc47f3.f737762f.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[1533],{72883:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>d,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var r=n(83117),a=(n(67294),n(3905));const i={title:"Setup SSH Tunneling",hide_title:!0,sidebar_position:12,version:1},l=void 0,o={unversionedId:"installation/setup-ssh-tunneling",id:"installation/setup-ssh-tunneling",title:"Setup SSH Tunneling",description:"SSH Tunneling",source:"@site/docs/installation/setup-ssh-tunneling.mdx",sourceDirName:"installation",slug:"/installation/setup-ssh-tunneling",permalink:"/docs/installation/setup-ssh-tunneling",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/installation/setup-ssh-tunneling.mdx",tags:[],version:"current",sidebarPosition:12,frontMatter:{title:"Setup SSH Tunneling",hide_title:!0,sidebar_position:12,version:1},sidebar:"tutorialSidebar",previous:{title:"SQL Templating",permalink:"/docs/installation/sql-templating"},next:{title:"Installing Database Drivers",permalink:"/docs/databases/installing-database-drivers"}},s={},u=[{value:"SSH Tunneling",id:"ssh-tunneling",level:2}],p={toc:u},c="wrapper";function d(e){let{components:t,...n}=e;return(0,a.kt)(c,(0,r.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"ssh-tunneling"},"SSH Tunneling"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Turn on feature flag"),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Change ",(0,a.kt)("a",{parentName:"li",href:"https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L489"},(0,a.kt)("inlineCode",{parentName:"a"},"SSH_TUNNELING"))," to ",(0,a.kt)("inlineCode",{parentName:"li"},"True")),(0,a.kt)("li",{parentName:"ul"},"If you want to add more security when establishing the tunnel we allow users to overwrite the ",(0,a.kt)("inlineCode",{parentName:"li"},"SSHTunnelManager")," class ",(0,a.kt)("a",{parentName:"li",href:"https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L507"},"here")),(0,a.kt)("li",{parentName:"ul"},"You can also set the ",(0,a.kt)("a",{parentName:"li",href:"https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L508"},(0,a.kt)("inlineCode",{parentName:"a"},"SSH_TUNNEL_LOCAL_BIND_ADDRESS"))," this the host address where the tunnel will be accessible on your VPC"))),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Create database w/ ssh tunnel enabled"),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"With the feature flag enabled you should now see ssh tunnel toggle."),(0,a.kt)("li",{parentName:"ul"},"Click the toggle to enables ssh tunneling and add your credentials accordingly.",(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Superset allows for 2 different type authenticaion (Basic + Private Key). These credentials should come from your service provider."))))),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},"Verify data is flowing"),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Once SSH tunneling has been enabled, go to SQL Lab and write a query to verify data is properly flowing.")))))}d.isMDXComponent=!0},3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>m});var r=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function o(e,t){if(null==e)return{};var n,r,a=function(e,t){if(null==e)return{};var n,r,a={},i=Object.keys(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r<i.length;r++)n=i[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var s=r.createContext({}),u=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},f=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),c=u(n),f=a,m=c["".concat(s,".").concat(f)]||c[f]||d[f]||i;return n?r.createElement(m,l(l({ref:t},p),{},{components:n})):r.createElement(m,l({ref:t},p))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=f;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o[c]="string"==typeof e?e:a,l[1]=o;for(var u=2;u<i;u++)l[u]=n[u];return r.createElement.apply(null,l)}return r.createElement.apply(null,n)}f.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/a9e1a7f6.0d4009b6.js b/assets/js/a9e1a7f6.0d4009b6.js
deleted file mode 100644
index 2b9159a..0000000
--- a/assets/js/a9e1a7f6.0d4009b6.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[5324],{7921:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var o=n(83117),a=(n(67294),n(3905));const r={title:"Installing Locally Using Docker Compose",hide_title:!0,sidebar_position:1,version:1},i=void 0,s={unversionedId:"installation/installing-superset-using-docker-compose",id:"installation/installing-superset-using-docker-compose",title:"Installing Locally Using Docker Compose",description:"Installing Superset Locally Using Docker Compose",source:"@site/docs/installation/installing-superset-using-docker-compose.mdx",sourceDirName:"installation",slug:"/installation/installing-superset-using-docker-compose",permalink:"/docs/installation/installing-superset-using-docker-compose",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/installation/installing-superset-using-docker-compose.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{title:"Installing Locally Using Docker Compose",hide_title:!0,sidebar_position:1,version:1},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/docs/intro"},next:{title:"Installing From Scratch",permalink:"/docs/installation/installing-superset-from-scratch"}},l={},c=[{value:"Installing Superset Locally Using Docker Compose",id:"installing-superset-locally-using-docker-compose",level:2},{value:"1. Install a Docker Engine and Docker Compose",id:"1-install-a-docker-engine-and-docker-compose",level:3},{value:"2. Clone Superset's GitHub repository",id:"2-clone-supersets-github-repository",level:3},{value:"3. Launch Superset Through Docker Compose",id:"3-launch-superset-through-docker-compose",level:3},{value:"Configuring Docker Compose",id:"configuring-docker-compose",level:4},{value:"4. Log in to Superset",id:"4-log-in-to-superset",level:3},{value:"5. Connecting Superset to your local database instance",id:"5-connecting-superset-to-your-local-database-instance",level:3}],p={toc:c},d="wrapper";function u(e){let{components:t,...n}=e;return(0,a.kt)(d,(0,o.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"installing-superset-locally-using-docker-compose"},"Installing Superset Locally Using Docker Compose"),(0,a.kt)("p",null,"The fastest way to try Superset locally is using Docker and Docker Compose on a Linux or Mac OSX\ncomputer. Superset does not have official support for Windows, so we have provided a VM workaround\nbelow."),(0,a.kt)("h3",{id:"1-install-a-docker-engine-and-docker-compose"},"1. Install a Docker Engine and Docker Compose"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Mac OSX")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://docs.docker.com/docker-for-mac/install/"},"Install Docker for Mac"),", which includes the Docker\nengine and a recent version of ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose")," out of the box."),(0,a.kt)("p",null,'Once you have Docker for Mac installed, open up the preferences pane for Docker, go to the\n"Resources" section and increase the allocated memory to 6GB. With only the 2GB of RAM allocated by\ndefault, Superset will fail to start.'),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Linux")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://docs.docker.com/engine/install/"},"Install Docker on Linux")," by following Docker\u2019s\ninstructions for whichever flavor of Linux suits you. Because ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose")," is not installed as\npart of the base Docker installation on Linux, once you have a working engine, follow the\n",(0,a.kt)("a",{parentName:"p",href:"https://docs.docker.com/compose/install/"},"docker-compose installation instructions")," for Linux."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Windows")),(0,a.kt)("p",null,"Superset is not officially supported on Windows unfortunately. One option for Windows users to\ntry out Superset locally is to install an Ubuntu Desktop VM via\n",(0,a.kt)("a",{parentName:"p",href:"https://www.virtualbox.org/"},"VirtualBox")," and proceed with the Docker on Linux instructions inside\nof that VM. We recommend assigning at least 8GB of RAM to the virtual machine as well as\nprovisioning a hard drive of at least 40GB, so that there will be enough space for both the OS and\nall of the required dependencies. Docker Desktop ",(0,a.kt)("a",{parentName:"p",href:"https://docs.docker.com/docker-for-windows/wsl/"},"recently added support for Windows Subsystem for Linux (WSL) 2"),", which may be another option."),(0,a.kt)("h3",{id:"2-clone-supersets-github-repository"},"2. Clone Superset's GitHub repository"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/apache/superset"},"Clone Superset's repo")," in your terminal with the\nfollowing command:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"git clone https://github.com/apache/superset.git\n")),(0,a.kt)("p",null,"Once that command completes successfully, you should see a new ",(0,a.kt)("inlineCode",{parentName:"p"},"superset")," folder in your\ncurrent directory."),(0,a.kt)("h3",{id:"3-launch-superset-through-docker-compose"},"3. Launch Superset Through Docker Compose"),(0,a.kt)("p",null,"Navigate to the folder you created in step 1:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"cd superset\n")),(0,a.kt)("p",null,"When working on master branch, run the following commands to run ",(0,a.kt)("inlineCode",{parentName:"p"},"development")," mode using ",(0,a.kt)("inlineCode",{parentName:"p"},"docker compose"),":"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"docker compose up\n")),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"When running in development mode the ",(0,a.kt)("inlineCode",{parentName:"p"},"superset-node")," container needs to finish building assets in order for the UI to render properly. If you would just like to try out Superset without making any code changes follow the steps documented for ",(0,a.kt)("inlineCode",{parentName:"p"},"production")," or a specific version below.")),(0,a.kt)("p",null,"When working on master branch, run the following commands to run ",(0,a.kt)("inlineCode",{parentName:"p"},"production")," mode using ",(0,a.kt)("inlineCode",{parentName:"p"},"docker compose"),":"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"docker-compose -f docker-compose-non-dev.yml pull\ndocker-compose -f docker-compose-non-dev.yml up\n")),(0,a.kt)("p",null,"Alternatively, you can also run a specific version of Superset by first checking out\nthe branch/tag, and then starting ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose")," with the ",(0,a.kt)("inlineCode",{parentName:"p"},"TAG")," variable.\nFor example, to run the 3.0.0 version, run the following commands:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"git checkout 3.0.0\nTAG=3.0.0 docker-compose -f docker-compose-non-dev.yml pull\nTAG=3.0.0 docker-compose -f docker-compose-non-dev.yml up\n")),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"Note that some configuration is mandatory for production instances of Superset. In particular, Superset will not start without a user-specified value of ",(0,a.kt)("inlineCode",{parentName:"p"},"SECRET_KEY"),". Please see ",(0,a.kt)("a",{parentName:"p",href:"https://superset.apache.org/docs/installation/configuring-superset/"},"Configuring Superset"),".")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"All of the content belonging to a Superset instance - charts, dashboards, users, etc. - is stored in its metadata database. In production, this database should be backed up.\nThe default installation with docker-compose will store that data in a PostgreSQL database contained in a Docker ",(0,a.kt)("a",{parentName:"p",href:"https://docs.docker.com/storage/volumes/"},"volume"),",\nwhich is not backed up. To avoid risking data loss, either use a managed database for your metadata (recommended) or perform your own regular backups by extracting\nand storing the contents of the default PostgreSQL database from its volume (here's an\n",(0,a.kt)("a",{parentName:"p",href:"https://stackoverflow.com/questions/24718706/backup-restore-a-dockerized-postgresql-database"},"example of how to dump and restore"),").")),(0,a.kt)("p",null,"You should see a wall of logging output from the containers being launched on your machine. Once\nthis output slows, you should have a running instance of Superset on your local machine! To\navoid the wall of text on future runs, add the ",(0,a.kt)("inlineCode",{parentName:"p"},"-d")," option to the end of the ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose up")," command."),(0,a.kt)("h4",{id:"configuring-docker-compose"},"Configuring Docker Compose"),(0,a.kt)("p",null,"The following is for users who want to configure how Superset runs in Docker Compose; otherwise, you can skip to the next section."),(0,a.kt)("p",null,"You can install additional python packages and apply config overrides by following the steps mentioned in ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/apache/superset/tree/master/docker#configuration"},"docker/README.md")),(0,a.kt)("p",null,"You can configure the Docker Compose environment varirables for dev and non-dev mode with ",(0,a.kt)("inlineCode",{parentName:"p"},"docker/.env")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"docker/.env-non-dev")," respectively. These environment files set the environment for most containers in the Docker Compose setup, and some variables affect multiple containers and others only single ones."),(0,a.kt)("p",null,"One important variable is ",(0,a.kt)("inlineCode",{parentName:"p"},"SUPERSET_LOAD_EXAMPLES")," which determines whether the ",(0,a.kt)("inlineCode",{parentName:"p"},"superset_init")," container will populate example data and visualizations into the metadata database. These examples are helpful for learning and testing out Superset but unnecessary for experienced users and production deployments. The loading process can sometimes take a few minutes and a good amount of CPU, so you may want to disable it on a resource-constrained device."),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"Users often want to connect to other databases from Superset. Currently, the easiest way to do this is to modify the ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose-non-dev.yml")," file and add your database as a service that the other services depend on (via ",(0,a.kt)("inlineCode",{parentName:"p"},"x-superset-depends-on"),"). Others have attempted to set ",(0,a.kt)("inlineCode",{parentName:"p"},"network_mode: host")," on the Superset services, but these generally break the installation, because the configuration requires use of the Docker Compose DNS resolver for the service names. If you have a good solution for this, let us know!")),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"Superset uses ",(0,a.kt)("a",{parentName:"p",href:"https://about.scarf.sh/scarf-gateway"},"Scarf Gateway")," to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics."),(0,a.kt)("p",{parentName:"admonition"},"To opt-out of this data collection in your docker-compose based installation, edit the ",(0,a.kt)("inlineCode",{parentName:"p"},"x-superset-image:")," line in your ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose.yml")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose-non-dev.yml")," files, replacing ",(0,a.kt)("inlineCode",{parentName:"p"},"apachesuperset.docker.scarf.sh/apache/superset")," with ",(0,a.kt)("inlineCode",{parentName:"p"},"apache/superset")," to pull the image directly from Docker Hub.")),(0,a.kt)("h3",{id:"4-log-in-to-superset"},"4. Log in to Superset"),(0,a.kt)("p",null,"Your local Superset instance also includes a Postgres server to store your data and is already\npre-loaded with some example datasets that ship with Superset. You can access Superset now via your\nweb browser by visiting ",(0,a.kt)("inlineCode",{parentName:"p"},"http://localhost:8088"),". Note that many browsers now default to ",(0,a.kt)("inlineCode",{parentName:"p"},"https")," - if\nyours is one of them, please make sure it uses ",(0,a.kt)("inlineCode",{parentName:"p"},"http"),"."),(0,a.kt)("p",null,"Log in with the default username and password:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"username: admin\n")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"password: admin\n")),(0,a.kt)("h3",{id:"5-connecting-superset-to-your-local-database-instance"},"5. Connecting Superset to your local database instance"),(0,a.kt)("p",null,"When running Superset using ",(0,a.kt)("inlineCode",{parentName:"p"},"docker")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose")," it runs in its own docker container, as if the Superset was running in a separate machine entirely. Therefore attempts to connect to your local database with the hostname ",(0,a.kt)("inlineCode",{parentName:"p"},"localhost")," won't work as ",(0,a.kt)("inlineCode",{parentName:"p"},"localhost")," refers to the docker container Superset is running in, and not your actual host machine. Fortunately, docker provides an easy way to access network resources in the host machine from inside a container, and we will leverage this capability to connect to our local database instance."),(0,a.kt)("p",null,"Here the instructions are for connecting to postgresql (which is running on your host machine) from Superset (which is running in its docker container). Other databases may have slightly different configurations but gist would be same and boils down to 2 steps -"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("strong",{parentName:"li"},"(Mac users may skip this step)")," Configuring the local postgresql/database instance to accept public incoming connections. By default, postgresql only allows incoming connections from ",(0,a.kt)("inlineCode",{parentName:"li"},"localhost")," and under Docker, unless you use ",(0,a.kt)("inlineCode",{parentName:"li"},"--network=host"),", ",(0,a.kt)("inlineCode",{parentName:"li"},"localhost")," will refer to different endpoints on the host machine and in a docker container respectively. Allowing postgresql to accept connections from the Docker involves making one-line changes to the files ",(0,a.kt)("inlineCode",{parentName:"li"},"postgresql.conf")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"pg_hba.conf"),"; you can find helpful links tailored to your OS / PG version on the web easily for this task. For Docker it suffices to only whitelist IPs ",(0,a.kt)("inlineCode",{parentName:"li"},"172.0.0.0/8")," instead of ",(0,a.kt)("inlineCode",{parentName:"li"},"*"),", but in any case you are ",(0,a.kt)("em",{parentName:"li"},"warned")," that doing this in a production database ",(0,a.kt)("em",{parentName:"li"},"may")," have disastrous consequences as you are opening your database to the public internet."),(0,a.kt)("li",{parentName:"ol"},"Instead of ",(0,a.kt)("inlineCode",{parentName:"li"},"localhost"),", try using ",(0,a.kt)("inlineCode",{parentName:"li"},"host.docker.internal")," (Mac users, Ubuntu) or ",(0,a.kt)("inlineCode",{parentName:"li"},"172.18.0.1")," (Linux users) as the hostname when attempting to connect to the database. This is a Docker internal detail -- what is happening is that, in Mac systems, Docker Desktop creates a dns entry for the hostname ",(0,a.kt)("inlineCode",{parentName:"li"},"host.docker.internal")," which resolves to the correct address for the host machine, whereas in Linux this is not the case (at least by default). If neither of these 2 hostnames work then you may want to find the exact hostname you want to use, for that you can do ",(0,a.kt)("inlineCode",{parentName:"li"},"ifconfig")," or ",(0,a.kt)("inlineCode",{parentName:"li"},"ip addr show")," and look at the IP address of ",(0,a.kt)("inlineCode",{parentName:"li"},"docker0")," interface that must have been created by Docker for you. Alternately if you don't even see the ",(0,a.kt)("inlineCode",{parentName:"li"},"docker0")," interface try (if needed with sudo) ",(0,a.kt)("inlineCode",{parentName:"li"},"docker network inspect bridge")," and see if there is an entry for ",(0,a.kt)("inlineCode",{parentName:"li"},'"Gateway"')," and note the IP address.")))}u.isMDXComponent=!0},3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var o=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?r(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):r(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,o,a=function(e,t){if(null==e)return{};var n,o,a={},r=Object.keys(e);for(o=0;o<r.length;o++)n=r[o],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(o=0;o<r.length;o++)n=r[o],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=o.createContext({}),c=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},m=o.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=c(n),m=a,h=d["".concat(l,".").concat(m)]||d[m]||u[m]||r;return n?o.createElement(h,i(i({ref:t},p),{},{components:n})):o.createElement(h,i({ref:t},p))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,i=new Array(r);i[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:a,i[1]=s;for(var c=2;c<r;c++)i[c]=n[c];return o.createElement.apply(null,i)}return o.createElement.apply(null,n)}m.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/a9e1a7f6.a97cbcf8.js b/assets/js/a9e1a7f6.a97cbcf8.js
new file mode 100644
index 0000000..562c35e
--- /dev/null
+++ b/assets/js/a9e1a7f6.a97cbcf8.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[5324],{7921:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>c});var o=n(83117),a=(n(67294),n(3905));const r={title:"Installing Locally Using Docker Compose",hide_title:!0,sidebar_position:1,version:1},i=void 0,s={unversionedId:"installation/installing-superset-using-docker-compose",id:"installation/installing-superset-using-docker-compose",title:"Installing Locally Using Docker Compose",description:"Installing Superset Locally Using Docker Compose",source:"@site/docs/installation/installing-superset-using-docker-compose.mdx",sourceDirName:"installation",slug:"/installation/installing-superset-using-docker-compose",permalink:"/docs/installation/installing-superset-using-docker-compose",draft:!1,editUrl:"https://github.com/apache/superset/tree/master/docs/docs/installation/installing-superset-using-docker-compose.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{title:"Installing Locally Using Docker Compose",hide_title:!0,sidebar_position:1,version:1},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/docs/intro"},next:{title:"Installing From Scratch",permalink:"/docs/installation/installing-superset-from-scratch"}},l={},c=[{value:"Installing Superset Locally Using Docker Compose",id:"installing-superset-locally-using-docker-compose",level:2},{value:"1. Install a Docker Engine and Docker Compose",id:"1-install-a-docker-engine-and-docker-compose",level:3},{value:"2. Clone Superset's GitHub repository",id:"2-clone-supersets-github-repository",level:3},{value:"3. Launch Superset Through Docker Compose",id:"3-launch-superset-through-docker-compose",level:3},{value:"Configuring Docker Compose",id:"configuring-docker-compose",level:4},{value:"4. Log in to Superset",id:"4-log-in-to-superset",level:3},{value:"5. Connecting Superset to your local database instance",id:"5-connecting-superset-to-your-local-database-instance",level:3}],p={toc:c},d="wrapper";function u(e){let{components:t,...n}=e;return(0,a.kt)(d,(0,o.Z)({},p,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"installing-superset-locally-using-docker-compose"},"Installing Superset Locally Using Docker Compose"),(0,a.kt)("p",null,"The fastest way to try Superset locally is using Docker and Docker Compose on a Linux or Mac OSX\ncomputer. Superset does not have official support for Windows, so we have provided a VM workaround\nbelow."),(0,a.kt)("h3",{id:"1-install-a-docker-engine-and-docker-compose"},"1. Install a Docker Engine and Docker Compose"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Mac OSX")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://docs.docker.com/docker-for-mac/install/"},"Install Docker for Mac"),", which includes the Docker\nengine and a recent version of ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose")," out of the box."),(0,a.kt)("p",null,'Once you have Docker for Mac installed, open up the preferences pane for Docker, go to the\n"Resources" section and increase the allocated memory to 6GB. With only the 2GB of RAM allocated by\ndefault, Superset will fail to start.'),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Linux")),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://docs.docker.com/engine/install/"},"Install Docker on Linux")," by following Docker\u2019s\ninstructions for whichever flavor of Linux suits you. Because ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose")," is not installed as\npart of the base Docker installation on Linux, once you have a working engine, follow the\n",(0,a.kt)("a",{parentName:"p",href:"https://docs.docker.com/compose/install/"},"docker-compose installation instructions")," for Linux."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Windows")),(0,a.kt)("p",null,"Superset is not officially supported on Windows unfortunately. One option for Windows users to\ntry out Superset locally is to install an Ubuntu Desktop VM via\n",(0,a.kt)("a",{parentName:"p",href:"https://www.virtualbox.org/"},"VirtualBox")," and proceed with the Docker on Linux instructions inside\nof that VM. We recommend assigning at least 8GB of RAM to the virtual machine as well as\nprovisioning a hard drive of at least 40GB, so that there will be enough space for both the OS and\nall of the required dependencies. Docker Desktop ",(0,a.kt)("a",{parentName:"p",href:"https://docs.docker.com/docker-for-windows/wsl/"},"recently added support for Windows Subsystem for Linux (WSL) 2"),", which may be another option."),(0,a.kt)("h3",{id:"2-clone-supersets-github-repository"},"2. Clone Superset's GitHub repository"),(0,a.kt)("p",null,(0,a.kt)("a",{parentName:"p",href:"https://github.com/apache/superset"},"Clone Superset's repo")," in your terminal with the\nfollowing command:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"git clone https://github.com/apache/superset.git\n")),(0,a.kt)("p",null,"Once that command completes successfully, you should see a new ",(0,a.kt)("inlineCode",{parentName:"p"},"superset")," folder in your\ncurrent directory."),(0,a.kt)("h3",{id:"3-launch-superset-through-docker-compose"},"3. Launch Superset Through Docker Compose"),(0,a.kt)("p",null,"Navigate to the folder you created in step 1:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"cd superset\n")),(0,a.kt)("p",null,"When working on master branch, run the following commands to run ",(0,a.kt)("inlineCode",{parentName:"p"},"development")," mode using ",(0,a.kt)("inlineCode",{parentName:"p"},"docker compose"),":"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"docker compose up\n")),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"When running in development mode the ",(0,a.kt)("inlineCode",{parentName:"p"},"superset-node")," container needs to finish building assets in order for the UI to render properly. If you would just like to try out Superset without making any code changes follow the steps documented for ",(0,a.kt)("inlineCode",{parentName:"p"},"production")," or a specific version below.")),(0,a.kt)("p",null,"When working on master branch, run the following commands to run ",(0,a.kt)("inlineCode",{parentName:"p"},"production")," mode using ",(0,a.kt)("inlineCode",{parentName:"p"},"docker compose"),":"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"docker-compose -f docker-compose-non-dev.yml pull\ndocker-compose -f docker-compose-non-dev.yml up\n")),(0,a.kt)("p",null,"Alternatively, you can also run a specific version of Superset by first checking out\nthe branch/tag, and then starting ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose")," with the ",(0,a.kt)("inlineCode",{parentName:"p"},"TAG")," variable.\nFor example, to run the 3.0.0 version, run the following commands:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"git checkout 3.0.0\nTAG=3.0.0 docker-compose -f docker-compose-non-dev.yml pull\nTAG=3.0.0 docker-compose -f docker-compose-non-dev.yml up\n")),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"Note that some configuration is mandatory for production instances of Superset. In particular, Superset will not start without a user-specified value of ",(0,a.kt)("inlineCode",{parentName:"p"},"SECRET_KEY"),". Please see ",(0,a.kt)("a",{parentName:"p",href:"https://superset.apache.org/docs/installation/configuring-superset/"},"Configuring Superset"),".")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"All of the content belonging to a Superset instance - charts, dashboards, users, etc. - is stored in its metadata database. In production, this database should be backed up.\nThe default installation with docker-compose will store that data in a PostgreSQL database contained in a Docker ",(0,a.kt)("a",{parentName:"p",href:"https://docs.docker.com/storage/volumes/"},"volume"),",\nwhich is not backed up. To avoid risking data loss, either use a managed database for your metadata (recommended) or perform your own regular backups by extracting\nand storing the contents of the default PostgreSQL database from its volume (here's an\n",(0,a.kt)("a",{parentName:"p",href:"https://stackoverflow.com/questions/24718706/backup-restore-a-dockerized-postgresql-database"},"example of how to dump and restore"),").")),(0,a.kt)("p",null,"You should see a wall of logging output from the containers being launched on your machine. Once\nthis output slows, you should have a running instance of Superset on your local machine! To\navoid the wall of text on future runs, add the ",(0,a.kt)("inlineCode",{parentName:"p"},"-d")," option to the end of the ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose up")," command."),(0,a.kt)("h4",{id:"configuring-docker-compose"},"Configuring Docker Compose"),(0,a.kt)("p",null,"The following is for users who want to configure how Superset runs in Docker Compose; otherwise, you can skip to the next section."),(0,a.kt)("p",null,"You can install additional python packages and apply config overrides by following the steps mentioned in ",(0,a.kt)("a",{parentName:"p",href:"https://github.com/apache/superset/tree/master/docker#configuration"},"docker/README.md")),(0,a.kt)("p",null,"You can configure the Docker Compose environment variables for dev and non-dev mode with ",(0,a.kt)("inlineCode",{parentName:"p"},"docker/.env")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"docker/.env-non-dev")," respectively. These environment files set the environment for most containers in the Docker Compose setup, and some variables affect multiple containers and others only single ones."),(0,a.kt)("p",null,"One important variable is ",(0,a.kt)("inlineCode",{parentName:"p"},"SUPERSET_LOAD_EXAMPLES")," which determines whether the ",(0,a.kt)("inlineCode",{parentName:"p"},"superset_init")," container will populate example data and visualizations into the metadata database. These examples are helpful for learning and testing out Superset but unnecessary for experienced users and production deployments. The loading process can sometimes take a few minutes and a good amount of CPU, so you may want to disable it on a resource-constrained device."),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"Users often want to connect to other databases from Superset. Currently, the easiest way to do this is to modify the ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose-non-dev.yml")," file and add your database as a service that the other services depend on (via ",(0,a.kt)("inlineCode",{parentName:"p"},"x-superset-depends-on"),"). Others have attempted to set ",(0,a.kt)("inlineCode",{parentName:"p"},"network_mode: host")," on the Superset services, but these generally break the installation, because the configuration requires use of the Docker Compose DNS resolver for the service names. If you have a good solution for this, let us know!")),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"Superset uses ",(0,a.kt)("a",{parentName:"p",href:"https://about.scarf.sh/scarf-gateway"},"Scarf Gateway")," to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics."),(0,a.kt)("p",{parentName:"admonition"},"To opt-out of this data collection in your docker-compose based installation, edit the ",(0,a.kt)("inlineCode",{parentName:"p"},"x-superset-image:")," line in your ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose.yml")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose-non-dev.yml")," files, replacing ",(0,a.kt)("inlineCode",{parentName:"p"},"apachesuperset.docker.scarf.sh/apache/superset")," with ",(0,a.kt)("inlineCode",{parentName:"p"},"apache/superset")," to pull the image directly from Docker Hub.")),(0,a.kt)("h3",{id:"4-log-in-to-superset"},"4. Log in to Superset"),(0,a.kt)("p",null,"Your local Superset instance also includes a Postgres server to store your data and is already\npre-loaded with some example datasets that ship with Superset. You can access Superset now via your\nweb browser by visiting ",(0,a.kt)("inlineCode",{parentName:"p"},"http://localhost:8088"),". Note that many browsers now default to ",(0,a.kt)("inlineCode",{parentName:"p"},"https")," - if\nyours is one of them, please make sure it uses ",(0,a.kt)("inlineCode",{parentName:"p"},"http"),"."),(0,a.kt)("p",null,"Log in with the default username and password:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"username: admin\n")),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-bash"},"password: admin\n")),(0,a.kt)("h3",{id:"5-connecting-superset-to-your-local-database-instance"},"5. Connecting Superset to your local database instance"),(0,a.kt)("p",null,"When running Superset using ",(0,a.kt)("inlineCode",{parentName:"p"},"docker")," or ",(0,a.kt)("inlineCode",{parentName:"p"},"docker-compose")," it runs in its own docker container, as if the Superset was running in a separate machine entirely. Therefore attempts to connect to your local database with the hostname ",(0,a.kt)("inlineCode",{parentName:"p"},"localhost")," won't work as ",(0,a.kt)("inlineCode",{parentName:"p"},"localhost")," refers to the docker container Superset is running in, and not your actual host machine. Fortunately, docker provides an easy way to access network resources in the host machine from inside a container, and we will leverage this capability to connect to our local database instance."),(0,a.kt)("p",null,"Here the instructions are for connecting to postgresql (which is running on your host machine) from Superset (which is running in its docker container). Other databases may have slightly different configurations but gist would be same and boils down to 2 steps -"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("strong",{parentName:"li"},"(Mac users may skip this step)")," Configuring the local postgresql/database instance to accept public incoming connections. By default, postgresql only allows incoming connections from ",(0,a.kt)("inlineCode",{parentName:"li"},"localhost")," and under Docker, unless you use ",(0,a.kt)("inlineCode",{parentName:"li"},"--network=host"),", ",(0,a.kt)("inlineCode",{parentName:"li"},"localhost")," will refer to different endpoints on the host machine and in a docker container respectively. Allowing postgresql to accept connections from the Docker involves making one-line changes to the files ",(0,a.kt)("inlineCode",{parentName:"li"},"postgresql.conf")," and ",(0,a.kt)("inlineCode",{parentName:"li"},"pg_hba.conf"),"; you can find helpful links tailored to your OS / PG version on the web easily for this task. For Docker it suffices to only whitelist IPs ",(0,a.kt)("inlineCode",{parentName:"li"},"172.0.0.0/8")," instead of ",(0,a.kt)("inlineCode",{parentName:"li"},"*"),", but in any case you are ",(0,a.kt)("em",{parentName:"li"},"warned")," that doing this in a production database ",(0,a.kt)("em",{parentName:"li"},"may")," have disastrous consequences as you are opening your database to the public internet."),(0,a.kt)("li",{parentName:"ol"},"Instead of ",(0,a.kt)("inlineCode",{parentName:"li"},"localhost"),", try using ",(0,a.kt)("inlineCode",{parentName:"li"},"host.docker.internal")," (Mac users, Ubuntu) or ",(0,a.kt)("inlineCode",{parentName:"li"},"172.18.0.1")," (Linux users) as the hostname when attempting to connect to the database. This is a Docker internal detail -- what is happening is that, in Mac systems, Docker Desktop creates a dns entry for the hostname ",(0,a.kt)("inlineCode",{parentName:"li"},"host.docker.internal")," which resolves to the correct address for the host machine, whereas in Linux this is not the case (at least by default). If neither of these 2 hostnames work then you may want to find the exact hostname you want to use, for that you can do ",(0,a.kt)("inlineCode",{parentName:"li"},"ifconfig")," or ",(0,a.kt)("inlineCode",{parentName:"li"},"ip addr show")," and look at the IP address of ",(0,a.kt)("inlineCode",{parentName:"li"},"docker0")," interface that must have been created by Docker for you. Alternately if you don't even see the ",(0,a.kt)("inlineCode",{parentName:"li"},"docker0")," interface try (if needed with sudo) ",(0,a.kt)("inlineCode",{parentName:"li"},"docker network inspect bridge")," and see if there is an entry for ",(0,a.kt)("inlineCode",{parentName:"li"},'"Gateway"')," and note the IP address.")))}u.isMDXComponent=!0},3905:(e,t,n)=>{n.d(t,{Zo:()=>p,kt:()=>h});var o=n(67294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?r(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):r(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function s(e,t){if(null==e)return{};var n,o,a=function(e,t){if(null==e)return{};var n,o,a={},r=Object.keys(e);for(o=0;o<r.length;o++)n=r[o],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(o=0;o<r.length;o++)n=r[o],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=o.createContext({}),c=function(e){var t=o.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=c(e.components);return o.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},m=o.forwardRef((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=c(n),m=a,h=d["".concat(l,".").concat(m)]||d[m]||u[m]||r;return n?o.createElement(h,i(i({ref:t},p),{},{components:n})):o.createElement(h,i({ref:t},p))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,i=new Array(r);i[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:a,i[1]=s;for(var c=2;c<r;c++)i[c]=n[c];return o.createElement.apply(null,i)}return o.createElement.apply(null,n)}m.displayName="MDXCreateElement"}}]);
\ No newline at end of file
diff --git a/assets/js/runtime~main.1706d5bb.js b/assets/js/runtime~main.80273ab1.js
similarity index 91%
rename from assets/js/runtime~main.1706d5bb.js
rename to assets/js/runtime~main.80273ab1.js
index 6215bb3..70b6b7d 100644
--- a/assets/js/runtime~main.1706d5bb.js
+++ b/assets/js/runtime~main.80273ab1.js
@@ -1 +1 @@
-(()=>{"use strict";var e,a,c,f,d,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,r),c.loaded=!0,c.exports}r.m=b,r.c=t,e=[],r.O=(a,c,f,d)=>{if(!c){var b=1/0;for(i=0;i<e.length;i++){c=e[i][0],f=e[i][1],d=e[i][2];for(var t=!0,o=0;o<c.length;o++)(!1&d||b>=d)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,d<b&&(b=d));if(t){e.splice(i--,1);var n=f();void 0!==n&&(a=n)}}return a}d=d||0;for(var i=e.length;i>0&&e[i-1][2]>d;i--)e[i]=e[i-1];e[i]=[c,f,d]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);r.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var t=2&f&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(d,b),d},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",112:"afef705c",229:"25f17725",340:"070b53d1",396:"0ae8b3d4",515:"53bb5fc4",599:"3c585fdb",674:"67158350",742:"dd0670d3",907:"c1424005",1083:"bd23e567",1444:"69a4ab96",1533:"6edc47f3",1964:"5e15fec9",2331:"19682bb8",2429:"d5417e33",2942:"eb23a929",3085:"1f391b9e",3206:"f8409a7e",3237:"1df93b7f",3628:"fa1a3aa0",3672:"cf6ffe2f",3775:"496bf018",3821:"21b4b958",3909:"cd90435d",3945:"a309f86e",3996:"9791fd42",4003:"6432bc55",4014:"5e50ba72",4096:"c76f729d",4244:"4cc2c078",4281:"1c734f75",4343:"18cf5ace",4490:"262418cd",4519:"2c412ea7",4586:"dc3fdd24",4628:"1ce51947",4729:"0c21af39",4745:"30ec1363",4796:"471df853",4992:"dc737160",5097:"a584ba2a",5114:"5ea65e65",5324:"a9e1a7f6",5542:"729f57ad",5551:"da60bc8f",5643:"30334fcd",5720:"30256b0d",5851:"8660bbc8",5906:"e7c796a6",6126:"e0a8f778",6230:"2bafca50",6455:"4e664dc4",6547:"1c42a294",6552:"6948bca1",6849:"57b59cd4",6860:"dbb131dd",7107:"d76e6194",7251:"9d6fd8ea",7271:"6a90d500",7285:"b92f705c",7380:"640bc8a0",7414:"393be207",7566:"972382ea",7587:"3ec2c3f7",7600:"2461ffa2",7706:"ce3fa444",7886:"5818c28e",7918:"17896441",7920:"1a4e3797",7937:"9a9c044b",8005:"600a9360",8015:"0e9953cd",8342:"eb3b0997",8402:"3c835dee",8561:"07f0ce13",8597:"f4a6e698",8718:"31e90f3c",8784:"35a5de3c",8835:"36ea7a08",8844:"b46ab14b",8853:"c296437a",8860:"71cf7fe6",8888:"ee5d850a",8915:"f9cc156b",9243:"40974919",9317:"f5f07875",9514:"1be78505",9594:"507542a3",9596:"88eaec5a",9617:"d83b78fc",9623:"904d61ef",9822:"fe0957ee"}[e]||e)+"."+{53:"70486ed5",112:"358a028d",229:"382b9496",340:"75523673",396:"e41dcf26",515:"d6fdf9a0",599:"ba58f5c5",674:"78305603",713:"e8404ec1",742:"233927aa",907:"df948777",975:"d95e9177",1083:"dc758238",1273:"c177fe37",1444:"8e098be3",1529:"cb77c953",1533:"f737762f",1964:"bc80b38a",2331:"aed0bf10",2387:"cf729afe",2429:"7d9140aa",2942:"7e9562fc",3085:"fabb506c",3206:"697ea5cb",3237:"bb60de38",3628:"1d62b77b",3672:"2621ec01",3775:"c0c9431f",3821:"84b9f6be",3909:"99f961ac",3945:"fd5212eb",3996:"b79f756c",4003:"ace5d07c",4014:"e794fd15",4096:"c85e22b7",4244:"1e2d58c9",4281:"8ed56248",4343:"e12f7ce7",4357:"c9ab8a8e",4471:"bf33ef73",4490:"d10e768c",4519:"86cadb8b",4586:"b8ae8b1f",4628:"9c631359",4729:"2a013c27",4745:"0671bedf",4796:"87918a03",4992:"0e71af99",5097:"a786479b",5114:"ffa26b77",5324:"0d4009b6",5542:"ef7e9987",5551:"18262bd8",5643:"b5a32572",5720:"be106e3e",5851:"ad0f3e8d",5906:"9d01f089",5957:"4fb6e613",6126:"c43c04dc",6230:"7f7fb7ca",6455:"426e997b",6547:"6bff09cc",6552:"88386997",6780:"ba84af4e",6849:"6dca875c",6860:"c82e4e25",6945:"d18f3d89",7029:"96f14d38",7107:"54d240ef",7251:"9ebcbca9",7271:"cd42f906",7285:"d654db2f",7380:"bb2d05f6",7414:"20dae7da",7566:"391f2ca7",7587:"6f37a44b",7600:"b19d6100",7706:"62a49085",7886:"7628cfa8",7918:"156729cb",7920:"8a952348",7937:"9da8e8a6",8005:"0b984638",8015:"040c3b57",8342:"4bb5d84b",8402:"63cab2ea",8561:"4aefae82",8597:"891ffbff",8718:"a0004b49",8784:"cc424d0a",8835:"b650668e",8844:"0b23475f",8853:"7dc8f3c7",8860:"7dc81586",8888:"28a37eb6",8915:"d1251bcf",9169:"36534697",9243:"d777f9aa",9317:"b65133c7",9514:"bfe07248",9594:"6f0ceed1",9596:"0ba04755",9617:"4bd95169",9623:"107093cb",9822:"f71b66b9"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="docs-v-2:",r.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i<n.length;i++){var l=n[i];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==d+c){t=l;break}}t||(o=!0,(t=document.createElement("script")).charset="utf-8",t.timeout=120,r.nc&&t.setAttribute("nonce",r.nc),t.setAttribute("data-webpack",d+c),t.src=e),f[e]=[a];var u=(a,c)=>{t.onerror=t.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],t.parentNode&&t.parentNode.removeChild(t),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={17896441:"7918",40974919:"9243",67158350:"674","935f2afb":"53",afef705c:"112","25f17725":"229","070b53d1":"340","0ae8b3d4":"396","53bb5fc4":"515","3c585fdb":"599",dd0670d3:"742",c1424005:"907",bd23e567:"1083","69a4ab96":"1444","6edc47f3":"1533","5e15fec9":"1964","19682bb8":"2331",d5417e33:"2429",eb23a929:"2942","1f391b9e":"3085",f8409a7e:"3206","1df93b7f":"3237",fa1a3aa0:"3628",cf6ffe2f:"3672","496bf018":"3775","21b4b958":"3821",cd90435d:"3909",a309f86e:"3945","9791fd42":"3996","6432bc55":"4003","5e50ba72":"4014",c76f729d:"4096","4cc2c078":"4244","1c734f75":"4281","18cf5ace":"4343","262418cd":"4490","2c412ea7":"4519",dc3fdd24:"4586","1ce51947":"4628","0c21af39":"4729","30ec1363":"4745","471df853":"4796",dc737160:"4992",a584ba2a:"5097","5ea65e65":"5114",a9e1a7f6:"5324","729f57ad":"5542",da60bc8f:"5551","30334fcd":"5643","30256b0d":"5720","8660bbc8":"5851",e7c796a6:"5906",e0a8f778:"6126","2bafca50":"6230","4e664dc4":"6455","1c42a294":"6547","6948bca1":"6552","57b59cd4":"6849",dbb131dd:"6860",d76e6194:"7107","9d6fd8ea":"7251","6a90d500":"7271",b92f705c:"7285","640bc8a0":"7380","393be207":"7414","972382ea":"7566","3ec2c3f7":"7587","2461ffa2":"7600",ce3fa444:"7706","5818c28e":"7886","1a4e3797":"7920","9a9c044b":"7937","600a9360":"8005","0e9953cd":"8015",eb3b0997:"8342","3c835dee":"8402","07f0ce13":"8561",f4a6e698:"8597","31e90f3c":"8718","35a5de3c":"8784","36ea7a08":"8835",b46ab14b:"8844",c296437a:"8853","71cf7fe6":"8860",ee5d850a:"8888",f9cc156b:"8915",f5f07875:"9317","1be78505":"9514","507542a3":"9594","88eaec5a":"9596",d83b78fc:"9617","904d61ef":"9623",fe0957ee:"9822"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,c)=>{var f=r.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=r.p+r.u(a),t=new Error;r.l(b,(c=>{if(r.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",t.name="ChunkLoadError",t.type=d,t.request=b,f[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],t=c[1],o=c[2],n=0;if(b.some((a=>0!==e[a]))){for(f in t)r.o(t,f)&&(r.m[f]=t[f]);if(o)var i=o(r)}for(a&&a(c);n<b.length;n++)d=b[n],r.o(e,d)&&e[d]&&e[d][0](),e[d]=0;return r.O(i)},c=self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[];c.forEach(a.bind(null,0)),c.push=a.bind(null,c.push.bind(c))})()})();
\ No newline at end of file
+(()=>{"use strict";var e,a,c,f,d,b={},t={};function r(e){var a=t[e];if(void 0!==a)return a.exports;var c=t[e]={id:e,loaded:!1,exports:{}};return b[e].call(c.exports,c,c.exports,r),c.loaded=!0,c.exports}r.m=b,r.c=t,e=[],r.O=(a,c,f,d)=>{if(!c){var b=1/0;for(i=0;i<e.length;i++){c=e[i][0],f=e[i][1],d=e[i][2];for(var t=!0,o=0;o<c.length;o++)(!1&d||b>=d)&&Object.keys(r.O).every((e=>r.O[e](c[o])))?c.splice(o--,1):(t=!1,d<b&&(b=d));if(t){e.splice(i--,1);var n=f();void 0!==n&&(a=n)}}return a}d=d||0;for(var i=e.length;i>0&&e[i-1][2]>d;i--)e[i]=e[i-1];e[i]=[c,f,d]},r.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return r.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,r.t=function(e,f){if(1&f&&(e=this(e)),8&f)return e;if("object"==typeof e&&e){if(4&f&&e.__esModule)return e;if(16&f&&"function"==typeof e.then)return e}var d=Object.create(null);r.r(d);var b={};a=a||[null,c({}),c([]),c(c)];for(var t=2&f&&e;"object"==typeof t&&!~a.indexOf(t);t=c(t))Object.getOwnPropertyNames(t).forEach((a=>b[a]=()=>e[a]));return b.default=()=>e,r.d(d,b),d},r.d=(e,a)=>{for(var c in a)r.o(a,c)&&!r.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},r.f={},r.e=e=>Promise.all(Object.keys(r.f).reduce(((a,c)=>(r.f[c](e,a),a)),[])),r.u=e=>"assets/js/"+({53:"935f2afb",112:"afef705c",229:"25f17725",340:"070b53d1",396:"0ae8b3d4",515:"53bb5fc4",599:"3c585fdb",674:"67158350",742:"dd0670d3",907:"c1424005",1083:"bd23e567",1444:"69a4ab96",1533:"6edc47f3",1964:"5e15fec9",2331:"19682bb8",2429:"d5417e33",2942:"eb23a929",3085:"1f391b9e",3206:"f8409a7e",3237:"1df93b7f",3628:"fa1a3aa0",3672:"cf6ffe2f",3775:"496bf018",3821:"21b4b958",3909:"cd90435d",3945:"a309f86e",3996:"9791fd42",4003:"6432bc55",4014:"5e50ba72",4096:"c76f729d",4244:"4cc2c078",4281:"1c734f75",4343:"18cf5ace",4490:"262418cd",4519:"2c412ea7",4586:"dc3fdd24",4628:"1ce51947",4729:"0c21af39",4745:"30ec1363",4796:"471df853",4992:"dc737160",5097:"a584ba2a",5114:"5ea65e65",5324:"a9e1a7f6",5542:"729f57ad",5551:"da60bc8f",5643:"30334fcd",5720:"30256b0d",5851:"8660bbc8",5906:"e7c796a6",6126:"e0a8f778",6230:"2bafca50",6455:"4e664dc4",6547:"1c42a294",6552:"6948bca1",6849:"57b59cd4",6860:"dbb131dd",7107:"d76e6194",7251:"9d6fd8ea",7271:"6a90d500",7285:"b92f705c",7380:"640bc8a0",7414:"393be207",7566:"972382ea",7587:"3ec2c3f7",7600:"2461ffa2",7706:"ce3fa444",7886:"5818c28e",7918:"17896441",7920:"1a4e3797",7937:"9a9c044b",8005:"600a9360",8015:"0e9953cd",8342:"eb3b0997",8402:"3c835dee",8561:"07f0ce13",8597:"f4a6e698",8718:"31e90f3c",8784:"35a5de3c",8835:"36ea7a08",8844:"b46ab14b",8853:"c296437a",8860:"71cf7fe6",8888:"ee5d850a",8915:"f9cc156b",9243:"40974919",9317:"f5f07875",9514:"1be78505",9594:"507542a3",9596:"88eaec5a",9617:"d83b78fc",9623:"904d61ef",9822:"fe0957ee"}[e]||e)+"."+{53:"70486ed5",112:"358a028d",229:"382b9496",340:"75523673",396:"e41dcf26",515:"d6fdf9a0",599:"ba58f5c5",674:"a3276773",713:"e8404ec1",742:"233927aa",907:"df948777",975:"d95e9177",1083:"dc758238",1273:"c177fe37",1444:"8e098be3",1529:"cb77c953",1533:"74bc8988",1964:"bc80b38a",2331:"66a691d6",2387:"cf729afe",2429:"7d9140aa",2942:"7e9562fc",3085:"fabb506c",3206:"697ea5cb",3237:"bb60de38",3628:"1d62b77b",3672:"2621ec01",3775:"c0c9431f",3821:"0e4bb161",3909:"99f961ac",3945:"fd5212eb",3996:"b79f756c",4003:"ace5d07c",4014:"2b277921",4096:"c85e22b7",4244:"1e2d58c9",4281:"8ed56248",4343:"e12f7ce7",4357:"c9ab8a8e",4471:"bf33ef73",4490:"d10e768c",4519:"86cadb8b",4586:"b8ae8b1f",4628:"9c631359",4729:"2a013c27",4745:"0671bedf",4796:"87918a03",4992:"0e71af99",5097:"a786479b",5114:"ffa26b77",5324:"a97cbcf8",5542:"ef7e9987",5551:"18262bd8",5643:"b5a32572",5720:"be106e3e",5851:"ad0f3e8d",5906:"9d01f089",5957:"4fb6e613",6126:"c43c04dc",6230:"7f7fb7ca",6455:"426e997b",6547:"6bff09cc",6552:"cde86692",6780:"ba84af4e",6849:"6dca875c",6860:"c82e4e25",6945:"d18f3d89",7029:"96f14d38",7107:"54d240ef",7251:"9ebcbca9",7271:"cd42f906",7285:"d654db2f",7380:"bb2d05f6",7414:"20dae7da",7566:"391f2ca7",7587:"6f37a44b",7600:"226a14e2",7706:"62a49085",7886:"7628cfa8",7918:"156729cb",7920:"8a952348",7937:"9da8e8a6",8005:"0b984638",8015:"6d25c537",8342:"4bb5d84b",8402:"63cab2ea",8561:"4aefae82",8597:"891ffbff",8718:"a0004b49",8784:"cc424d0a",8835:"b650668e",8844:"0b23475f",8853:"7dc8f3c7",8860:"7dc81586",8888:"28a37eb6",8915:"d1251bcf",9169:"36534697",9243:"d777f9aa",9317:"b65133c7",9514:"bfe07248",9594:"e5fff5b5",9596:"0ba04755",9617:"4bd95169",9623:"107093cb",9822:"f71b66b9"}[e]+".js",r.miniCssF=e=>{},r.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),r.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),f={},d="docs-v-2:",r.l=(e,a,c,b)=>{if(f[e])f[e].push(a);else{var t,o;if(void 0!==c)for(var n=document.getElementsByTagName("script"),i=0;i<n.length;i++){var l=n[i];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==d+c){t=l;break}}t||(o=!0,(t=document.createElement("script")).charset="utf-8",t.timeout=120,r.nc&&t.setAttribute("nonce",r.nc),t.setAttribute("data-webpack",d+c),t.src=e),f[e]=[a];var u=(a,c)=>{t.onerror=t.onload=null,clearTimeout(s);var d=f[e];if(delete f[e],t.parentNode&&t.parentNode.removeChild(t),d&&d.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:t}),12e4);t.onerror=u.bind(null,t.onerror),t.onload=u.bind(null,t.onload),o&&document.head.appendChild(t)}},r.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),r.p="/",r.gca=function(e){return e={17896441:"7918",40974919:"9243",67158350:"674","935f2afb":"53",afef705c:"112","25f17725":"229","070b53d1":"340","0ae8b3d4":"396","53bb5fc4":"515","3c585fdb":"599",dd0670d3:"742",c1424005:"907",bd23e567:"1083","69a4ab96":"1444","6edc47f3":"1533","5e15fec9":"1964","19682bb8":"2331",d5417e33:"2429",eb23a929:"2942","1f391b9e":"3085",f8409a7e:"3206","1df93b7f":"3237",fa1a3aa0:"3628",cf6ffe2f:"3672","496bf018":"3775","21b4b958":"3821",cd90435d:"3909",a309f86e:"3945","9791fd42":"3996","6432bc55":"4003","5e50ba72":"4014",c76f729d:"4096","4cc2c078":"4244","1c734f75":"4281","18cf5ace":"4343","262418cd":"4490","2c412ea7":"4519",dc3fdd24:"4586","1ce51947":"4628","0c21af39":"4729","30ec1363":"4745","471df853":"4796",dc737160:"4992",a584ba2a:"5097","5ea65e65":"5114",a9e1a7f6:"5324","729f57ad":"5542",da60bc8f:"5551","30334fcd":"5643","30256b0d":"5720","8660bbc8":"5851",e7c796a6:"5906",e0a8f778:"6126","2bafca50":"6230","4e664dc4":"6455","1c42a294":"6547","6948bca1":"6552","57b59cd4":"6849",dbb131dd:"6860",d76e6194:"7107","9d6fd8ea":"7251","6a90d500":"7271",b92f705c:"7285","640bc8a0":"7380","393be207":"7414","972382ea":"7566","3ec2c3f7":"7587","2461ffa2":"7600",ce3fa444:"7706","5818c28e":"7886","1a4e3797":"7920","9a9c044b":"7937","600a9360":"8005","0e9953cd":"8015",eb3b0997:"8342","3c835dee":"8402","07f0ce13":"8561",f4a6e698:"8597","31e90f3c":"8718","35a5de3c":"8784","36ea7a08":"8835",b46ab14b:"8844",c296437a:"8853","71cf7fe6":"8860",ee5d850a:"8888",f9cc156b:"8915",f5f07875:"9317","1be78505":"9514","507542a3":"9594","88eaec5a":"9596",d83b78fc:"9617","904d61ef":"9623",fe0957ee:"9822"}[e]||e,r.p+r.u(e)},(()=>{var e={1303:0,532:0};r.f.j=(a,c)=>{var f=r.o(e,a)?e[a]:void 0;if(0!==f)if(f)c.push(f[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var d=new Promise(((c,d)=>f=e[a]=[c,d]));c.push(f[2]=d);var b=r.p+r.u(a),t=new Error;r.l(b,(c=>{if(r.o(e,a)&&(0!==(f=e[a])&&(e[a]=void 0),f)){var d=c&&("load"===c.type?"missing":c.type),b=c&&c.target&&c.target.src;t.message="Loading chunk "+a+" failed.\n("+d+": "+b+")",t.name="ChunkLoadError",t.type=d,t.request=b,f[1](t)}}),"chunk-"+a,a)}},r.O.j=a=>0===e[a];var a=(a,c)=>{var f,d,b=c[0],t=c[1],o=c[2],n=0;if(b.some((a=>0!==e[a]))){for(f in t)r.o(t,f)&&(r.m[f]=t[f]);if(o)var i=o(r)}for(a&&a(c);n<b.length;n++)d=b[n],r.o(e,d)&&e[d]&&e[d][0](),e[d]=0;return r.O(i)},c=self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[];c.forEach(a.bind(null,0)),c.push=a.bind(null,c.push.bind(c))})()})();
\ No newline at end of file
diff --git a/community/index.html b/community/index.html
index b58f4d0..597ccb4 100644
--- a/community/index.html
+++ b/community/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/api/index.html b/docs/api/index.html
index 58be38d..7551f02 100644
--- a/docs/api/index.html
+++ b/docs/api/index.html
@@ -18,14 +18,14 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/superset-logo-horiz.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/superset-logo-horiz-dark.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Documentation</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/intro">Getting Started</a></li><li><a class="dropdown__link" href="/docs/frequently-asked-questions">FAQ</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/community">Resources</a></li><li><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">GitHub<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="http://bit.ly/join-superset-slack" target="_blank" rel="noopener noreferrer" class="dropdown__link">Slack<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://lists.apache.org/list.html?dev@superset.apache.org" target="_blank" rel="noopener noreferrer" class="dropdown__link">Mailing List<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://stackoverflow.com/questions/tagged/superset+apache-superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">Stack Overflow<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link default-button-theme get-started-button" href="/docs/intro">Get Started</a><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link github-button"></a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/intro">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/installation/installing-superset-using-docker-compose">Installation and Configuration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/databases/installing-database-drivers">Connecting to Databases</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/creating-charts-dashboards/creating-your-first-dashboard">Creating Charts and Dashboards</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/miscellaneous/country-map-tools">Miscellaneous</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/contributing/contributing-page">Contributing</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/frequently-asked-questions">Frequently Asked Questions</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/docs/api">API</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/security/">Security</a><button aria-label="Toggle the collapsible sidebar category 'Security'" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">API</span><meta itemprop="position" content="1"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h2 class="anchor anchorWithStickyNavbar_LWe7" id="api">API<a href="#api" class="hash-link" aria-label="Direct link to API" title="Direct link to API"></a></h2><p>Superset's public <strong>REST API</strong> follows the
<a href="https://swagger.io/specification/" target="_blank" rel="noopener noreferrer">OpenAPI specification</a>, and is
-documented here. The docs bellow are generated using
+documented here. The docs below are generated using
<a href="https://www.npmjs.com/package/swagger-ui-react" target="_blank" rel="noopener noreferrer">Swagger React UI</a>.</p><div data-show="true" class="ant-alert ant-alert-info ant-alert-no-icon" role="alert"><div class="ant-alert-content"><div class="ant-alert-message"><div><strong>NOTE! </strong>You can find an interactive version of this documentation on your local Superset instance at <strong>/swagger/v1</strong> (unless disabled)</div></div></div></div><br><br><hr><div class="swagger-container"></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/superset/tree/master/docs/docs/api.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/frequently-asked-questions"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Frequently Asked Questions</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/security/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Role based Access</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#api" class="table-of-contents__link toc-highlight">API</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="footer__applitools">
We use <a href="https://applitools.com/" target="_blank" rel="nofollow"><img src="/img/applitools.png" title="Applitools"></a>
@@ -48,7 +48,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/contributing/contributing-page/index.html b/docs/contributing/contributing-page/index.html
index 444e664..122078e 100644
--- a/docs/contributing/contributing-page/index.html
+++ b/docs/contributing/contributing-page/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -47,7 +47,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/contributing/conventions-and-typing/index.html b/docs/contributing/conventions-and-typing/index.html
index c12c80a..a194f73 100644
--- a/docs/contributing/conventions-and-typing/index.html
+++ b/docs/contributing/conventions-and-typing/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -49,7 +49,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/contributing/creating-viz-plugins/index.html b/docs/contributing/creating-viz-plugins/index.html
index c885113..4b3b79d 100644
--- a/docs/contributing/creating-viz-plugins/index.html
+++ b/docs/contributing/creating-viz-plugins/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -61,7 +61,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/contributing/hooks-and-linting/index.html b/docs/contributing/hooks-and-linting/index.html
index 51676ef..2ca0e2c 100644
--- a/docs/contributing/hooks-and-linting/index.html
+++ b/docs/contributing/hooks-and-linting/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/contributing/local-backend/index.html b/docs/contributing/local-backend/index.html
index 4c75fdd..2c2c89a 100644
--- a/docs/contributing/local-backend/index.html
+++ b/docs/contributing/local-backend/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -48,7 +48,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/contributing/pull-request-guidelines/index.html b/docs/contributing/pull-request-guidelines/index.html
index 2a06613..64c8986 100644
--- a/docs/contributing/pull-request-guidelines/index.html
+++ b/docs/contributing/pull-request-guidelines/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/contributing/style-guide/index.html b/docs/contributing/style-guide/index.html
index 111b585..5a04332 100644
--- a/docs/contributing/style-guide/index.html
+++ b/docs/contributing/style-guide/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -48,7 +48,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/contributing/testing-locally/index.html b/docs/contributing/testing-locally/index.html
index e3b8487..25f8578 100644
--- a/docs/contributing/testing-locally/index.html
+++ b/docs/contributing/testing-locally/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -52,7 +52,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/contributing/translations/index.html b/docs/contributing/translations/index.html
index 910999c..f7d6cae 100644
--- a/docs/contributing/translations/index.html
+++ b/docs/contributing/translations/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -36,7 +36,7 @@
option inside will add a language selection dropdown to the UI on the right side
of the navigation bar.</p><div class="language-python codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-python codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">LANGUAGES </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">'en'</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token string" style="color:#e3116c">'flag'</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'us'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'name'</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'English'</span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">'fr'</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token string" style="color:#e3116c">'flag'</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'fr'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'name'</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'French'</span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">'zh'</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token string" style="color:#e3116c">'flag'</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'cn'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'name'</span><span class="token punctuation" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'Chinese'</span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="creating-a-new-language-dictionary">Creating a new language dictionary<a href="#creating-a-new-language-dictionary" class="hash-link" aria-label="Direct link to Creating a new language dictionary" title="Direct link to Creating a new language dictionary"></a></h3><p>First check if the language code for your target language already exists. Check if the
<a href="https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes" target="_blank" rel="noopener noreferrer">two letter ISO 639-1 code</a>
-for your target language already exists in the <code>superset/translations</code> directory:</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">ls</span><span class="token plain"> superset/translations </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">grep</span><span class="token plain"> -E </span><span class="token string" style="color:#e3116c">"^[a-z]{2}\/"</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>If your language already has a pre-existing translation, skip to the next section</p><p>The following languages are already supported by Flask AppBuilder, and will make it
+for your target language already exists in the <code>superset/translations</code> directory:</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">ls</span><span class="token plain"> superset/translations </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">grep</span><span class="token plain"> -E </span><span class="token string" style="color:#e3116c">"^[a-z]{2}\/"</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>If your language already has a preexisting translation, skip to the next section</p><p>The following languages are already supported by Flask AppBuilder, and will make it
easier to translate the application to your target language:
<a href="https://flask-appbuilder.readthedocs.io/en/latest/i18n.html" target="_blank" rel="noopener noreferrer">Flask AppBuilder i18n documentation</a></p><p>To create a dictionary for a new language, first make sure the necessary dependencies are installed:</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">pip </span><span class="token function" style="color:#d73a49">install</span><span class="token plain"> -r superset/translations/requirements.txt</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Then run the following, where <code>LANGUAGE_CODE</code> is replaced with the language code for your target
language:</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">pybabel init -i superset/translations/messages.pot -d superset/translations -l LANGUAGE_CODE</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>For instance, to add a translation for Finnish (language code <code>fi</code>), run the following:</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">pybabel init -i superset/translations/messages.pot -d superset/translations -l </span><span class="token keyword" style="color:#00009f">fi</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="extracting-new-strings-for-translation">Extracting new strings for translation<a href="#extracting-new-strings-for-translation" class="hash-link" aria-label="Direct link to Extracting new strings for translation" title="Direct link to Extracting new strings for translation"></a></h3><p>This step needs to be done every time application strings change. This happens fairly
@@ -76,7 +76,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/contributing/types-of-contributions/index.html b/docs/contributing/types-of-contributions/index.html
index 9390b42..750621a 100644
--- a/docs/contributing/types-of-contributions/index.html
+++ b/docs/contributing/types-of-contributions/index.html
@@ -18,19 +18,19 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/superset-logo-horiz.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/superset-logo-horiz-dark.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Documentation</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/intro">Getting Started</a></li><li><a class="dropdown__link" href="/docs/frequently-asked-questions">FAQ</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/community">Resources</a></li><li><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">GitHub<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="http://bit.ly/join-superset-slack" target="_blank" rel="noopener noreferrer" class="dropdown__link">Slack<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://lists.apache.org/list.html?dev@superset.apache.org" target="_blank" rel="noopener noreferrer" class="dropdown__link">Mailing List<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://stackoverflow.com/questions/tagged/superset+apache-superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">Stack Overflow<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link default-button-theme get-started-button" href="/docs/intro">Get Started</a><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link github-button"></a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/intro">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/installation/installing-superset-using-docker-compose">Installation and Configuration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/databases/installing-database-drivers">Connecting to Databases</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/creating-charts-dashboards/creating-your-first-dashboard">Creating Charts and Dashboards</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/miscellaneous/country-map-tools">Miscellaneous</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/contributing/contributing-page">Contributing</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/contributing/contributing-page">Contributing to Superset</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/contributing/types-of-contributions">Types of Contributions</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/contributing/pull-request-guidelines">Pull Request Guidelines</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/contributing/style-guide">Style Guide</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/contributing/local-backend">Running a Local Flask Backend</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/contributing/hooks-and-linting">Pre-commit Hooks and Linting</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/contributing/conventions-and-typing">Conventions and Typing</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/contributing/testing-locally">Testing</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/contributing/translations">Translating</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/contributing/creating-viz-plugins">Creating Visualization Plugins</a></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/frequently-asked-questions">Frequently Asked Questions</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api">API</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/security/">Security</a><button aria-label="Toggle the collapsible sidebar category 'Security'" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Contributing</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Types of Contributions</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h2 class="anchor anchorWithStickyNavbar_LWe7" id="types-of-contributions">Types of Contributions<a href="#types-of-contributions" class="hash-link" aria-label="Direct link to Types of Contributions" title="Direct link to Types of Contributions"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="report-bug">Report Bug<a href="#report-bug" class="hash-link" aria-label="Direct link to Report Bug" title="Direct link to Report Bug"></a></h3><p>The best way to report a bug is to file an issue on GitHub. Please include:</p><ul><li>Your operating system name and version.</li><li>Superset version.</li><li>Detailed steps to reproduce the bug.</li><li>Any details about your local setup that might be helpful in troubleshooting.</li></ul><p>When posting Python stack traces, please quote them using
-<a href="https://help.github.com/articles/creating-and-highlighting-code-blocks/" target="_blank" rel="noopener noreferrer">Markdown blocks</a>.</p><p><em>Please note that feature requests opened as Github Issues will be moved to Discussions.</em></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="submit-ideas-or-feature-requests">Submit Ideas or Feature Requests<a href="#submit-ideas-or-feature-requests" class="hash-link" aria-label="Direct link to Submit Ideas or Feature Requests" title="Direct link to Submit Ideas or Feature Requests"></a></h3><p>The best way is to start an <a href="https://github.com/apache/superset/discussions/categories/ideas" target="_blank" rel="noopener noreferrer">"Ideas" Discussion thread</a> on GitHub:</p><ul><li>Explain in detail how it would work.</li><li>Keep the scope as narrow as possible, to make it easier to implement.</li><li>Remember that this is a volunteer-driven project, and that your contributions are as welcome as anyone's :)</li></ul><p>To propose large features or major changes to codebase, and help usher in those changes, please create a <strong>Superset Improvement Proposal (SIP)</strong>. See template from <a href="https://github.com/apache/superset/issues/5602" target="_blank" rel="noopener noreferrer">SIP-0</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fix-bugs">Fix Bugs<a href="#fix-bugs" class="hash-link" aria-label="Direct link to Fix Bugs" title="Direct link to Fix Bugs"></a></h3><p>Look through the GitHub issues. Issues tagged with <code>#bug</code> are
+<a href="https://help.github.com/articles/creating-and-highlighting-code-blocks/" target="_blank" rel="noopener noreferrer">Markdown blocks</a>.</p><p><em>Please note that feature requests opened as GitHub Issues will be moved to Discussions.</em></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="submit-ideas-or-feature-requests">Submit Ideas or Feature Requests<a href="#submit-ideas-or-feature-requests" class="hash-link" aria-label="Direct link to Submit Ideas or Feature Requests" title="Direct link to Submit Ideas or Feature Requests"></a></h3><p>The best way is to start an <a href="https://github.com/apache/superset/discussions/categories/ideas" target="_blank" rel="noopener noreferrer">"Ideas" Discussion thread</a> on GitHub:</p><ul><li>Explain in detail how it would work.</li><li>Keep the scope as narrow as possible, to make it easier to implement.</li><li>Remember that this is a volunteer-driven project, and that your contributions are as welcome as anyone's :)</li></ul><p>To propose large features or major changes to codebase, and help usher in those changes, please create a <strong>Superset Improvement Proposal (SIP)</strong>. See template from <a href="https://github.com/apache/superset/issues/5602" target="_blank" rel="noopener noreferrer">SIP-0</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="fix-bugs">Fix Bugs<a href="#fix-bugs" class="hash-link" aria-label="Direct link to Fix Bugs" title="Direct link to Fix Bugs"></a></h3><p>Look through the GitHub issues. Issues tagged with <code>#bug</code> are
open to whoever wants to implement them.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="implement-features">Implement Features<a href="#implement-features" class="hash-link" aria-label="Direct link to Implement Features" title="Direct link to Implement Features"></a></h3><p>Look through the GitHub issues. Issues tagged with
<code>#feature</code> is open to whoever wants to implement it.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="improve-documentation">Improve Documentation<a href="#improve-documentation" class="hash-link" aria-label="Direct link to Improve Documentation" title="Direct link to Improve Documentation"></a></h3><p>Superset could always use better documentation,
whether as part of the official Superset docs,
in docstrings, <code>docs/*.rst</code> or even on the web as blog posts or
articles. See <a href="#documentation">Documentation</a> for more details.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="add-translations">Add Translations<a href="#add-translations" class="hash-link" aria-label="Direct link to Add Translations" title="Direct link to Add Translations"></a></h3><p>If you are proficient in a non-English language, you can help translate
-text strings from Superset's UI. You can jump in to the existing
+text strings from Superset's UI. You can jump into the existing
language dictionaries at
<code>superset/translations/<language_code>/LC_MESSAGES/messages.po</code>, or
even create a dictionary for a new language altogether.
@@ -56,7 +56,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/creating-charts-dashboards/creating-your-first-dashboard/index.html b/docs/creating-charts-dashboards/creating-your-first-dashboard/index.html
index a2cd0fc..d32e87e 100644
--- a/docs/creating-charts-dashboards/creating-your-first-dashboard/index.html
+++ b/docs/creating-charts-dashboards/creating-your-first-dashboard/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -36,7 +36,7 @@
<a href="/docs/installation/installing-superset-using-docker-compose">Docker compose</a>, you can
skip this step because a Postgres database, named <strong>examples</strong>, is included and
pre-configured in Superset for you.</p><p>Under the <strong>+</strong> menu in the top right, select Data, and then the <em>Connect Database</em> option:</p><img loading="lazy" src="/img/tutorial/tutorial_01_add_database_connection.png" width="600" class="img_ev3q"> <!-- --> <br><br><p>Then select your database type in the resulting modal:</p><img loading="lazy" src="/img/tutorial/tutorial_02_select_database.png" width="600" class="img_ev3q"> <!-- --> <br><br><p>Once you've selected a database, you can configure a number of advanced options in this window,
-or for the purposes of this this walkthrough, you can click the link below all these fields:</p><img loading="lazy" src="/img/tutorial/tutorial_03a_database_connection_string_link.png" width="600" class="img_ev3q"> <!-- --> <br><br><p>Once you've clicked that link you only need to specify two things (the database name and SQLAlchemy URI):</p><img loading="lazy" src="/img/tutorial/tutorial_03b_connection_string_details.png" width="600" class="img_ev3q"> <!-- --> <br><br><p>As noted in the text below the form, you should refer to the SQLAlchemy documentation on
+or for the purposes of this walkthrough, you can click the link below all these fields:</p><img loading="lazy" src="/img/tutorial/tutorial_03a_database_connection_string_link.png" width="600" class="img_ev3q"> <!-- --> <br><br><p>Once you've clicked that link you only need to specify two things (the database name and SQLAlchemy URI):</p><img loading="lazy" src="/img/tutorial/tutorial_03b_connection_string_details.png" width="600" class="img_ev3q"> <!-- --> <br><br><p>As noted in the text below the form, you should refer to the SQLAlchemy documentation on
<a href="https://docs.sqlalchemy.org/en/12/core/engines.html#database-urls" target="_blank" rel="noopener noreferrer">creating new connection URIs</a>
for your target database.</p><p>Click the <strong>Test Connection</strong> button to confirm things work end to end. If the connection looks good, save the configuration
by clicking the <strong>Connect</strong> button in the bottom right corner of the modal window:</p><p>Congratulations, you've just added a new data source in Superset!</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="registering-a-new-table">Registering a new table<a href="#registering-a-new-table" class="hash-link" aria-label="Direct link to Registering a new table" title="Direct link to Registering a new table"></a></h3><p>Now that you’ve configured a data source, you can select specific tables (called <strong>Datasets</strong> in Superset)
@@ -88,7 +88,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/creating-charts-dashboards/exploring-data/index.html b/docs/creating-charts-dashboards/exploring-data/index.html
index 5fe132e..cc553df 100644
--- a/docs/creating-charts-dashboards/exploring-data/index.html
+++ b/docs/creating-charts-dashboards/exploring-data/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -150,7 +150,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/ascend/index.html b/docs/databases/ascend/index.html
index b91b4f0..168a969 100644
--- a/docs/databases/ascend/index.html
+++ b/docs/databases/ascend/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/athena/index.html b/docs/databases/athena/index.html
index 8dbba37..0f68e2c 100644
--- a/docs/databases/athena/index.html
+++ b/docs/databases/athena/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -47,7 +47,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/bigquery/index.html b/docs/databases/bigquery/index.html
index 152602e..751b7b6 100644
--- a/docs/databases/bigquery/index.html
+++ b/docs/databases/bigquery/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -52,7 +52,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/clickhouse/index.html b/docs/databases/clickhouse/index.html
index 03b4521..b01205f 100644
--- a/docs/databases/clickhouse/index.html
+++ b/docs/databases/clickhouse/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -47,7 +47,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/cockroachdb/index.html b/docs/databases/cockroachdb/index.html
index 2066812..c8b39bf 100644
--- a/docs/databases/cockroachdb/index.html
+++ b/docs/databases/cockroachdb/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/cratedb/index.html b/docs/databases/cratedb/index.html
index ae7f222..54eebbe 100644
--- a/docs/databases/cratedb/index.html
+++ b/docs/databases/cratedb/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -49,7 +49,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/databricks/index.html b/docs/databases/databricks/index.html
index 78d0e5d..1d95544 100644
--- a/docs/databases/databricks/index.html
+++ b/docs/databases/databricks/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/db-connection-ui/index.html b/docs/databases/db-connection-ui/index.html
index c5a5a07..7875fc5 100644
--- a/docs/databases/db-connection-ui/index.html
+++ b/docs/databases/db-connection-ui/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/docker-add-drivers/index.html b/docs/databases/docker-add-drivers/index.html
index f0ad55e..b167a1e 100644
--- a/docs/databases/docker-add-drivers/index.html
+++ b/docs/databases/docker-add-drivers/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -60,7 +60,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/dremio/index.html b/docs/databases/dremio/index.html
index 7dbeffa..51304ef 100644
--- a/docs/databases/dremio/index.html
+++ b/docs/databases/dremio/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -47,7 +47,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/drill/index.html b/docs/databases/drill/index.html
index c8b6893..f99fd14 100644
--- a/docs/databases/drill/index.html
+++ b/docs/databases/drill/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -52,7 +52,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/druid/index.html b/docs/databases/druid/index.html
index 1edcf0b..0523667 100644
--- a/docs/databases/druid/index.html
+++ b/docs/databases/druid/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -58,7 +58,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/dynamodb/index.html b/docs/databases/dynamodb/index.html
index 27b677f..b99d1e9 100644
--- a/docs/databases/dynamodb/index.html
+++ b/docs/databases/dynamodb/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/elasticsearch/index.html b/docs/databases/elasticsearch/index.html
index 895dd27..37d6089 100644
--- a/docs/databases/elasticsearch/index.html
+++ b/docs/databases/elasticsearch/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -52,7 +52,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/exasol/index.html b/docs/databases/exasol/index.html
index 183d06e..81bb151 100644
--- a/docs/databases/exasol/index.html
+++ b/docs/databases/exasol/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/extra-settings/index.html b/docs/databases/extra-settings/index.html
index d5be7d1..d6bdf2b 100644
--- a/docs/databases/extra-settings/index.html
+++ b/docs/databases/extra-settings/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -55,7 +55,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/firebird/index.html b/docs/databases/firebird/index.html
index 7b50977..ab4afcb 100644
--- a/docs/databases/firebird/index.html
+++ b/docs/databases/firebird/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/firebolt/index.html b/docs/databases/firebolt/index.html
index 14b29c4..0644904 100644
--- a/docs/databases/firebolt/index.html
+++ b/docs/databases/firebolt/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/google-sheets/index.html b/docs/databases/google-sheets/index.html
index 58733fc..fdc0985 100644
--- a/docs/databases/google-sheets/index.html
+++ b/docs/databases/google-sheets/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -49,7 +49,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/hana/index.html b/docs/databases/hana/index.html
index c48c3bc..afa3d6e 100644
--- a/docs/databases/hana/index.html
+++ b/docs/databases/hana/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/hive/index.html b/docs/databases/hive/index.html
index ebe7bac..2825f2a 100644
--- a/docs/databases/hive/index.html
+++ b/docs/databases/hive/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/hologres/index.html b/docs/databases/hologres/index.html
index b5bfabc..2003933 100644
--- a/docs/databases/hologres/index.html
+++ b/docs/databases/hologres/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/ibm-db2/index.html b/docs/databases/ibm-db2/index.html
index 956e0d5..fe35acf 100644
--- a/docs/databases/ibm-db2/index.html
+++ b/docs/databases/ibm-db2/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/impala/index.html b/docs/databases/impala/index.html
index 27dde0e..806a340 100644
--- a/docs/databases/impala/index.html
+++ b/docs/databases/impala/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/installing-database-drivers/index.html b/docs/databases/installing-database-drivers/index.html
index cb33c4b..a4576ed 100644
--- a/docs/databases/installing-database-drivers/index.html
+++ b/docs/databases/installing-database-drivers/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -56,7 +56,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/kusto/index.html b/docs/databases/kusto/index.html
index 845f910..b6f29ab 100644
--- a/docs/databases/kusto/index.html
+++ b/docs/databases/kusto/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -47,7 +47,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/kylin/index.html b/docs/databases/kylin/index.html
index a119776..e36e8c1 100644
--- a/docs/databases/kylin/index.html
+++ b/docs/databases/kylin/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/meta-database/index.html b/docs/databases/meta-database/index.html
index 4738f27..5d9d6bb 100644
--- a/docs/databases/meta-database/index.html
+++ b/docs/databases/meta-database/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/mysql/index.html b/docs/databases/mysql/index.html
index d1fc168..1ea0a4d 100644
--- a/docs/databases/mysql/index.html
+++ b/docs/databases/mysql/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/netezza/index.html b/docs/databases/netezza/index.html
index 5fb1614..6dabd95 100644
--- a/docs/databases/netezza/index.html
+++ b/docs/databases/netezza/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/ocient/index.html b/docs/databases/ocient/index.html
index 2b30fb2..995d94b 100644
--- a/docs/databases/ocient/index.html
+++ b/docs/databases/ocient/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -47,7 +47,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/oracle/index.html b/docs/databases/oracle/index.html
index 7e4b195..6c886be 100644
--- a/docs/databases/oracle/index.html
+++ b/docs/databases/oracle/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/pinot/index.html b/docs/databases/pinot/index.html
index 3410012..01ddd61 100644
--- a/docs/databases/pinot/index.html
+++ b/docs/databases/pinot/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/postgres/index.html b/docs/databases/postgres/index.html
index 10e2319..a655764 100644
--- a/docs/databases/postgres/index.html
+++ b/docs/databases/postgres/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -50,7 +50,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/presto/index.html b/docs/databases/presto/index.html
index e090ea8..db33f09 100644
--- a/docs/databases/presto/index.html
+++ b/docs/databases/presto/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/redshift/index.html b/docs/databases/redshift/index.html
index 7501912..4935ea9 100644
--- a/docs/databases/redshift/index.html
+++ b/docs/databases/redshift/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/risingwave/index.html b/docs/databases/risingwave/index.html
index f1a5208..0d97723 100644
--- a/docs/databases/risingwave/index.html
+++ b/docs/databases/risingwave/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/rockset/index.html b/docs/databases/rockset/index.html
index 02a1e8a..1a89de7 100644
--- a/docs/databases/rockset/index.html
+++ b/docs/databases/rockset/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/snowflake/index.html b/docs/databases/snowflake/index.html
index 88cc487..4522f79 100644
--- a/docs/databases/snowflake/index.html
+++ b/docs/databases/snowflake/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -32,7 +32,7 @@
button in the Create or Edit Database dialog, user/role credentials are validated by passing
“validate_default_parameters”: True to the connect() method during engine creation. If the user/role
is not authorized to access the database, an error is recorded in the Superset logs.</p><p>And if you want connect Snowflake with <a href="https://docs.snowflake.com/en/user-guide/key-pair-auth.html#step-6-configure-the-snowflake-client-to-use-key-pair-authentication" target="_blank" rel="noopener noreferrer">Key Pair Authentication</a>.
-Plase make sure you have the key pair and the public key is registered in Snowflake.
+Please make sure you have the key pair and the public key is registered in Snowflake.
To connect Snowflake with Key Pair Authentication, you need to add the following parameters to "SECURE EXTRA" field.</p><p><strong><em>Please note that you need to merge multi-line private key content to one line and insert <code>\n</code> between each line</em></strong></p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "auth_method": "keypair",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "auth_params": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "privatekey_body": "-----BEGIN ENCRYPTED PRIVATE KEY-----\n...\n...\n-----END ENCRYPTED PRIVATE KEY-----",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "privatekey_pass":"Your Private Key Password"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>If your private key is stored on server, you can replace "privatekey_body" with “privatekey_path” in parameter.</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "auth_method": "keypair",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "auth_params": {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "privatekey_path":"Your Private Key Path",</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> "privatekey_pass":"Your Private Key Password"</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/superset/tree/master/docs/docs/databases/snowflake.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/databases/presto"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Presto</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/databases/sql-server"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Microsoft SQL Server</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#snowflake" class="table-of-contents__link toc-highlight">Snowflake</a><ul><li><a href="#install-snowflake-driver" class="table-of-contents__link toc-highlight">Install Snowflake Driver</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="footer__applitools">
We use <a href="https://applitools.com/" target="_blank" rel="nofollow"><img src="/img/applitools.png" title="Applitools"></a>
@@ -55,7 +55,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/solr/index.html b/docs/databases/solr/index.html
index 22e2cf3..114300e 100644
--- a/docs/databases/solr/index.html
+++ b/docs/databases/solr/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/spark-sql/index.html b/docs/databases/spark-sql/index.html
index 7c31ec2..02bfa2b 100644
--- a/docs/databases/spark-sql/index.html
+++ b/docs/databases/spark-sql/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/sql-server/index.html b/docs/databases/sql-server/index.html
index c76e4af..0905d33 100644
--- a/docs/databases/sql-server/index.html
+++ b/docs/databases/sql-server/index.html
@@ -18,12 +18,12 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
-<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/superset-logo-horiz.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/superset-logo-horiz-dark.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Documentation</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/intro">Getting Started</a></li><li><a class="dropdown__link" href="/docs/frequently-asked-questions">FAQ</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/community">Resources</a></li><li><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">GitHub<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="http://bit.ly/join-superset-slack" target="_blank" rel="noopener noreferrer" class="dropdown__link">Slack<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://lists.apache.org/list.html?dev@superset.apache.org" target="_blank" rel="noopener noreferrer" class="dropdown__link">Mailing List<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://stackoverflow.com/questions/tagged/superset+apache-superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">Stack Overflow<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link default-button-theme get-started-button" href="/docs/intro">Get Started</a><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link github-button"></a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/intro">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/installation/installing-superset-using-docker-compose">Installation and Configuration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/databases/installing-database-drivers">Connecting to Databases</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/installing-database-drivers">Installing Database Drivers</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/docker-add-drivers">Adding New Drivers in Docker</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/db-connection-ui">Using Database Connection UI</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/athena">Amazon Athena</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/dynamodb">Amazon DynamoDB</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/redshift">Amazon Redshift</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/starrocks">StarRocks</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/drill">Apache Drill</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/druid">Apache Druid</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/hive">Apache Hive</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/impala">Apache Impala</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/ascend">Ascend.io</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/kylin">Apache Kylin</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/pinot">Apache Pinot</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/solr">Apache Solr</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/spark-sql">Apache Spark SQL</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/clickhouse">ClickHouse</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/cockroachdb">CockroachDB</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/risingwave">RisingWave</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/dremio">Dremio</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/elasticsearch">Elasticsearch</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/exasol">Exasol</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/bigquery">Google BigQuery</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/ocient">Ocient DB</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/google-sheets">Google Sheets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/hana">Hana</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/ibm-db2">IBM DB2</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/netezza">IBM Netezza Performance Server</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/mysql">MySQL</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/oracle">Oracle</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/postgres">Postgres</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/presto">Presto</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/snowflake">Snowflake</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/databases/sql-server">Microsoft SQL Server</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/teradata">Teradata</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/timescaledb">TimescaleDB</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/vertica">Vertica</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/hologres">Hologres</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/trino">Trino</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/rockset">Rockset</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/cratedb">CrateDB</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/databricks">Databricks</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/firebird">Firebird</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/yugabytedb">YugabyteDB</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/firebolt">Firebolt</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/extra-settings">Extra Database Settings</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/kusto">kusto</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/meta-database">Querying across databases</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/creating-charts-dashboards/creating-your-first-dashboard">Creating Charts and Dashboards</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/miscellaneous/country-map-tools">Miscellaneous</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/contributing/contributing-page">Contributing</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/frequently-asked-questions">Frequently Asked Questions</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api">API</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/security/">Security</a><button aria-label="Toggle the collapsible sidebar category 'Security'" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Connecting to Databases</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Microsoft SQL Server</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h2 class="anchor anchorWithStickyNavbar_LWe7" id="sql-server">SQL Server<a href="#sql-server" class="hash-link" aria-label="Direct link to SQL Server" title="Direct link to SQL Server"></a></h2><p>The recommended connector library for SQL Server is <a href="https://github.com/pymssql/pymssql" target="_blank" rel="noopener noreferrer">pymssql</a>.</p><p>The connection string for SQL Server looks like this:</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">mssql+pymssql://<Username>:<Password>@<Host>:<Port-default:1433>/<Database Name>/?Encrypt=yes</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>It is also possible to connect using <a href="https://pypi.org/project/pyodbc" target="_blank" rel="noopener noreferrer">pyodbc</a> with the parameter <a href="https://docs.sqlalchemy.org/en/14/dialects/mssql.html#pass-through-exact-pyodbc-string" target="_blank" rel="noopener noreferrer">odbc_connect</a></p><p>The connection string for SQL Server looks like this:</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3Cmy_server%3E%2C1433%3BDatabase%3Dmy_datasbase%3BUid%3Dmy_user_name%3BPwd%3Dmy_password%3BEncrypt%3Dyes%3BConnection+Timeout%3D30</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/superset/tree/master/docs/docs/databases/sql-server.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/databases/snowflake"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Snowflake</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/databases/teradata"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Teradata</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#sql-server" class="table-of-contents__link toc-highlight">SQL Server</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">
+<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/superset-logo-horiz.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/superset-logo-horiz-dark.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Documentation</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/intro">Getting Started</a></li><li><a class="dropdown__link" href="/docs/frequently-asked-questions">FAQ</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/community">Resources</a></li><li><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">GitHub<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="http://bit.ly/join-superset-slack" target="_blank" rel="noopener noreferrer" class="dropdown__link">Slack<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://lists.apache.org/list.html?dev@superset.apache.org" target="_blank" rel="noopener noreferrer" class="dropdown__link">Mailing List<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://stackoverflow.com/questions/tagged/superset+apache-superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">Stack Overflow<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link default-button-theme get-started-button" href="/docs/intro">Get Started</a><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link github-button"></a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/intro">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/installation/installing-superset-using-docker-compose">Installation and Configuration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/databases/installing-database-drivers">Connecting to Databases</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/installing-database-drivers">Installing Database Drivers</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/docker-add-drivers">Adding New Drivers in Docker</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/db-connection-ui">Using Database Connection UI</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/athena">Amazon Athena</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/dynamodb">Amazon DynamoDB</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/redshift">Amazon Redshift</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/starrocks">StarRocks</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/drill">Apache Drill</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/druid">Apache Druid</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/hive">Apache Hive</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/impala">Apache Impala</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/ascend">Ascend.io</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/kylin">Apache Kylin</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/pinot">Apache Pinot</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/solr">Apache Solr</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/spark-sql">Apache Spark SQL</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/clickhouse">ClickHouse</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/cockroachdb">CockroachDB</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/risingwave">RisingWave</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/dremio">Dremio</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/elasticsearch">Elasticsearch</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/exasol">Exasol</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/bigquery">Google BigQuery</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/ocient">Ocient DB</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/google-sheets">Google Sheets</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/hana">Hana</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/ibm-db2">IBM DB2</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/netezza">IBM Netezza Performance Server</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/mysql">MySQL</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/oracle">Oracle</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/postgres">Postgres</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/presto">Presto</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/snowflake">Snowflake</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/databases/sql-server">Microsoft SQL Server</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/teradata">Teradata</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/timescaledb">TimescaleDB</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/vertica">Vertica</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/hologres">Hologres</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/trino">Trino</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/rockset">Rockset</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/cratedb">CrateDB</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/databricks">Databricks</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/firebird">Firebird</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/yugabytedb">YugabyteDB</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/firebolt">Firebolt</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/extra-settings">Extra Database Settings</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/kusto">kusto</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/databases/meta-database">Querying across databases</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/creating-charts-dashboards/creating-your-first-dashboard">Creating Charts and Dashboards</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/miscellaneous/country-map-tools">Miscellaneous</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/contributing/contributing-page">Contributing</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/frequently-asked-questions">Frequently Asked Questions</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api">API</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/security/">Security</a><button aria-label="Toggle the collapsible sidebar category 'Security'" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Connecting to Databases</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Microsoft SQL Server</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h2 class="anchor anchorWithStickyNavbar_LWe7" id="sql-server">SQL Server<a href="#sql-server" class="hash-link" aria-label="Direct link to SQL Server" title="Direct link to SQL Server"></a></h2><p>The recommended connector library for SQL Server is <a href="https://github.com/pymssql/pymssql" target="_blank" rel="noopener noreferrer">pymssql</a>.</p><p>The connection string for SQL Server looks like this:</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">mssql+pymssql://<Username>:<Password>@<Host>:<Port-default:1433>/<Database Name>/?Encrypt=yes</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>It is also possible to connect using <a href="https://pypi.org/project/pyodbc" target="_blank" rel="noopener noreferrer">pyodbc</a> with the parameter <a href="https://docs.sqlalchemy.org/en/14/dialects/mssql.html#pass-through-exact-pyodbc-string" target="_blank" rel="noopener noreferrer">odbc_connect</a></p><p>The connection string for SQL Server looks like this:</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">mssql+pyodbc:///?odbc_connect=Driver%3D%7BODBC+Driver+17+for+SQL+Server%7D%3BServer%3Dtcp%3A%3Cmy_server%3E%2C1433%3BDatabase%3Dmy_database%3BUid%3Dmy_user_name%3BPwd%3Dmy_password%3BEncrypt%3Dyes%3BConnection+Timeout%3D30</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/superset/tree/master/docs/docs/databases/sql-server.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/databases/snowflake"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Snowflake</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/databases/teradata"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Teradata</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#sql-server" class="table-of-contents__link toc-highlight">SQL Server</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="footer__applitools">
We use <a href="https://applitools.com/" target="_blank" rel="nofollow"><img src="/img/applitools.png" title="Applitools"></a>
</div>
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/starrocks/index.html b/docs/databases/starrocks/index.html
index 1accd3d..24fe174 100644
--- a/docs/databases/starrocks/index.html
+++ b/docs/databases/starrocks/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/teradata/index.html b/docs/databases/teradata/index.html
index 530a229..5e3ee75 100644
--- a/docs/databases/teradata/index.html
+++ b/docs/databases/teradata/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -52,7 +52,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/timescaledb/index.html b/docs/databases/timescaledb/index.html
index 3c1b147..748e515 100644
--- a/docs/databases/timescaledb/index.html
+++ b/docs/databases/timescaledb/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/trino/index.html b/docs/databases/trino/index.html
index 3659b11..2e32cc0 100644
--- a/docs/databases/trino/index.html
+++ b/docs/databases/trino/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -47,7 +47,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/vertica/index.html b/docs/databases/vertica/index.html
index 82a1f6c..bbeb7b6 100644
--- a/docs/databases/vertica/index.html
+++ b/docs/databases/vertica/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -47,7 +47,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/databases/yugabytedb/index.html b/docs/databases/yugabytedb/index.html
index 5bfcdf3..842c9c2 100644
--- a/docs/databases/yugabytedb/index.html
+++ b/docs/databases/yugabytedb/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -47,7 +47,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/frequently-asked-questions/index.html b/docs/frequently-asked-questions/index.html
index f98923e..05b9271 100644
--- a/docs/frequently-asked-questions/index.html
+++ b/docs/frequently-asked-questions/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -139,7 +139,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/installation/alerts-reports/index.html b/docs/installation/alerts-reports/index.html
index 31f0f2b..f37adba 100644
--- a/docs/installation/alerts-reports/index.html
+++ b/docs/installation/alerts-reports/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -64,7 +64,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/installation/async-queries-celery/index.html b/docs/installation/async-queries-celery/index.html
index 3d9e966..690154e 100644
--- a/docs/installation/async-queries-celery/index.html
+++ b/docs/installation/async-queries-celery/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -61,7 +61,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/installation/cache/index.html b/docs/installation/cache/index.html
index 88a9b6f..293dd05 100644
--- a/docs/installation/cache/index.html
+++ b/docs/installation/cache/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -64,7 +64,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/installation/configuring-superset/index.html b/docs/installation/configuring-superset/index.html
index 658c2ce..a13a90f 100644
--- a/docs/installation/configuring-superset/index.html
+++ b/docs/installation/configuring-superset/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -87,7 +87,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/installation/event-logging/index.html b/docs/installation/event-logging/index.html
index 8868931..d05370e 100644
--- a/docs/installation/event-logging/index.html
+++ b/docs/installation/event-logging/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -51,7 +51,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/installation/installing-superset-from-scratch/index.html b/docs/installation/installing-superset-from-scratch/index.html
index 9bc4bac..2890693 100644
--- a/docs/installation/installing-superset-from-scratch/index.html
+++ b/docs/installation/installing-superset-from-scratch/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -56,7 +56,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/installation/installing-superset-using-docker-compose/index.html b/docs/installation/installing-superset-using-docker-compose/index.html
index 8b48635..f239f00 100644
--- a/docs/installation/installing-superset-using-docker-compose/index.html
+++ b/docs/installation/installing-superset-using-docker-compose/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -46,7 +46,7 @@
and storing the contents of the default PostgreSQL database from its volume (here's an
<a href="https://stackoverflow.com/questions/24718706/backup-restore-a-dockerized-postgresql-database" target="_blank" rel="noopener noreferrer">example of how to dump and restore</a>).</p></div></div><p>You should see a wall of logging output from the containers being launched on your machine. Once
this output slows, you should have a running instance of Superset on your local machine! To
-avoid the wall of text on future runs, add the <code>-d</code> option to the end of the <code>docker-compose up</code> command.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuring-docker-compose">Configuring Docker Compose<a href="#configuring-docker-compose" class="hash-link" aria-label="Direct link to Configuring Docker Compose" title="Direct link to Configuring Docker Compose"></a></h4><p>The following is for users who want to configure how Superset runs in Docker Compose; otherwise, you can skip to the next section.</p><p>You can install additional python packages and apply config overrides by following the steps mentioned in <a href="https://github.com/apache/superset/tree/master/docker#configuration" target="_blank" rel="noopener noreferrer">docker/README.md</a></p><p>You can configure the Docker Compose environment varirables for dev and non-dev mode with <code>docker/.env</code> and <code>docker/.env-non-dev</code> respectively. These environment files set the environment for most containers in the Docker Compose setup, and some variables affect multiple containers and others only single ones.</p><p>One important variable is <code>SUPERSET_LOAD_EXAMPLES</code> which determines whether the <code>superset_init</code> container will populate example data and visualizations into the metadata database. These examples are helpful for learning and testing out Superset but unnecessary for experienced users and production deployments. The loading process can sometimes take a few minutes and a good amount of CPU, so you may want to disable it on a resource-constrained device.</p><div class="theme-admonition theme-admonition-note alert alert--secondary admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</div><div class="admonitionContent_S0QG"><p>Users often want to connect to other databases from Superset. Currently, the easiest way to do this is to modify the <code>docker-compose-non-dev.yml</code> file and add your database as a service that the other services depend on (via <code>x-superset-depends-on</code>). Others have attempted to set <code>network_mode: host</code> on the Superset services, but these generally break the installation, because the configuration requires use of the Docker Compose DNS resolver for the service names. If you have a good solution for this, let us know!</p></div></div><div class="theme-admonition theme-admonition-note alert alert--secondary admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</div><div class="admonitionContent_S0QG"><p>Superset uses <a href="https://about.scarf.sh/scarf-gateway" target="_blank" rel="noopener noreferrer">Scarf Gateway</a> to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics.</p><p>To opt-out of this data collection in your docker-compose based installation, edit the <code>x-superset-image:</code> line in your <code>docker-compose.yml</code> and <code>docker-compose-non-dev.yml</code> files, replacing <code>apachesuperset.docker.scarf.sh/apache/superset</code> with <code>apache/superset</code> to pull the image directly from Docker Hub.</p></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="4-log-in-to-superset">4. Log in to Superset<a href="#4-log-in-to-superset" class="hash-link" aria-label="Direct link to 4. Log in to Superset" title="Direct link to 4. Log in to Superset"></a></h3><p>Your local Superset instance also includes a Postgres server to store your data and is already
+avoid the wall of text on future runs, add the <code>-d</code> option to the end of the <code>docker-compose up</code> command.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="configuring-docker-compose">Configuring Docker Compose<a href="#configuring-docker-compose" class="hash-link" aria-label="Direct link to Configuring Docker Compose" title="Direct link to Configuring Docker Compose"></a></h4><p>The following is for users who want to configure how Superset runs in Docker Compose; otherwise, you can skip to the next section.</p><p>You can install additional python packages and apply config overrides by following the steps mentioned in <a href="https://github.com/apache/superset/tree/master/docker#configuration" target="_blank" rel="noopener noreferrer">docker/README.md</a></p><p>You can configure the Docker Compose environment variables for dev and non-dev mode with <code>docker/.env</code> and <code>docker/.env-non-dev</code> respectively. These environment files set the environment for most containers in the Docker Compose setup, and some variables affect multiple containers and others only single ones.</p><p>One important variable is <code>SUPERSET_LOAD_EXAMPLES</code> which determines whether the <code>superset_init</code> container will populate example data and visualizations into the metadata database. These examples are helpful for learning and testing out Superset but unnecessary for experienced users and production deployments. The loading process can sometimes take a few minutes and a good amount of CPU, so you may want to disable it on a resource-constrained device.</p><div class="theme-admonition theme-admonition-note alert alert--secondary admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</div><div class="admonitionContent_S0QG"><p>Users often want to connect to other databases from Superset. Currently, the easiest way to do this is to modify the <code>docker-compose-non-dev.yml</code> file and add your database as a service that the other services depend on (via <code>x-superset-depends-on</code>). Others have attempted to set <code>network_mode: host</code> on the Superset services, but these generally break the installation, because the configuration requires use of the Docker Compose DNS resolver for the service names. If you have a good solution for this, let us know!</p></div></div><div class="theme-admonition theme-admonition-note alert alert--secondary admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</div><div class="admonitionContent_S0QG"><p>Superset uses <a href="https://about.scarf.sh/scarf-gateway" target="_blank" rel="noopener noreferrer">Scarf Gateway</a> to collect telemetry data. Knowing the installation counts for different Superset versions informs the project's decisions about patching and long-term support. Scarf purges personally identifiable information (PII) and provides only aggregated statistics.</p><p>To opt-out of this data collection in your docker-compose based installation, edit the <code>x-superset-image:</code> line in your <code>docker-compose.yml</code> and <code>docker-compose-non-dev.yml</code> files, replacing <code>apachesuperset.docker.scarf.sh/apache/superset</code> with <code>apache/superset</code> to pull the image directly from Docker Hub.</p></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="4-log-in-to-superset">4. Log in to Superset<a href="#4-log-in-to-superset" class="hash-link" aria-label="Direct link to 4. Log in to Superset" title="Direct link to 4. Log in to Superset"></a></h3><p>Your local Superset instance also includes a Postgres server to store your data and is already
pre-loaded with some example datasets that ship with Superset. You can access Superset now via your
web browser by visiting <code>http://localhost:8088</code>. Note that many browsers now default to <code>https</code> - if
yours is one of them, please make sure it uses <code>http</code>.</p><p>Log in with the default username and password:</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">username: admin</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">password: admin</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="5-connecting-superset-to-your-local-database-instance">5. Connecting Superset to your local database instance<a href="#5-connecting-superset-to-your-local-database-instance" class="hash-link" aria-label="Direct link to 5. Connecting Superset to your local database instance" title="Direct link to 5. Connecting Superset to your local database instance"></a></h3><p>When running Superset using <code>docker</code> or <code>docker-compose</code> it runs in its own docker container, as if the Superset was running in a separate machine entirely. Therefore attempts to connect to your local database with the hostname <code>localhost</code> won't work as <code>localhost</code> refers to the docker container Superset is running in, and not your actual host machine. Fortunately, docker provides an easy way to access network resources in the host machine from inside a container, and we will leverage this capability to connect to our local database instance.</p><p>Here the instructions are for connecting to postgresql (which is running on your host machine) from Superset (which is running in its docker container). Other databases may have slightly different configurations but gist would be same and boils down to 2 steps -</p><ol><li><strong>(Mac users may skip this step)</strong> Configuring the local postgresql/database instance to accept public incoming connections. By default, postgresql only allows incoming connections from <code>localhost</code> and under Docker, unless you use <code>--network=host</code>, <code>localhost</code> will refer to different endpoints on the host machine and in a docker container respectively. Allowing postgresql to accept connections from the Docker involves making one-line changes to the files <code>postgresql.conf</code> and <code>pg_hba.conf</code>; you can find helpful links tailored to your OS / PG version on the web easily for this task. For Docker it suffices to only whitelist IPs <code>172.0.0.0/8</code> instead of <code>*</code>, but in any case you are <em>warned</em> that doing this in a production database <em>may</em> have disastrous consequences as you are opening your database to the public internet.</li><li>Instead of <code>localhost</code>, try using <code>host.docker.internal</code> (Mac users, Ubuntu) or <code>172.18.0.1</code> (Linux users) as the hostname when attempting to connect to the database. This is a Docker internal detail -- what is happening is that, in Mac systems, Docker Desktop creates a dns entry for the hostname <code>host.docker.internal</code> which resolves to the correct address for the host machine, whereas in Linux this is not the case (at least by default). If neither of these 2 hostnames work then you may want to find the exact hostname you want to use, for that you can do <code>ifconfig</code> or <code>ip addr show</code> and look at the IP address of <code>docker0</code> interface that must have been created by Docker for you. Alternately if you don't even see the <code>docker0</code> interface try (if needed with sudo) <code>docker network inspect bridge</code> and see if there is an entry for <code>"Gateway"</code> and note the IP address.</li></ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/superset/tree/master/docs/docs/installation/installing-superset-using-docker-compose.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/intro"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Introduction</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/installation/installing-superset-from-scratch"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Installing From Scratch</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#installing-superset-locally-using-docker-compose" class="table-of-contents__link toc-highlight">Installing Superset Locally Using Docker Compose</a><ul><li><a href="#1-install-a-docker-engine-and-docker-compose" class="table-of-contents__link toc-highlight">1. Install a Docker Engine and Docker Compose</a></li><li><a href="#2-clone-supersets-github-repository" class="table-of-contents__link toc-highlight">2. Clone Superset's GitHub repository</a></li><li><a href="#3-launch-superset-through-docker-compose" class="table-of-contents__link toc-highlight">3. Launch Superset Through Docker Compose</a></li><li><a href="#4-log-in-to-superset" class="table-of-contents__link toc-highlight">4. Log in to Superset</a></li><li><a href="#5-connecting-superset-to-your-local-database-instance" class="table-of-contents__link toc-highlight">5. Connecting Superset to your local database instance</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">
@@ -71,7 +71,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/installation/networking-settings/index.html b/docs/installation/networking-settings/index.html
index 7ebf987..acaa862 100644
--- a/docs/installation/networking-settings/index.html
+++ b/docs/installation/networking-settings/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -54,7 +54,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/installation/running-on-kubernetes/index.html b/docs/installation/running-on-kubernetes/index.html
index 3e6eacf..f322f99 100644
--- a/docs/installation/running-on-kubernetes/index.html
+++ b/docs/installation/running-on-kubernetes/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -53,7 +53,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/installation/setup-ssh-tunneling/index.html b/docs/installation/setup-ssh-tunneling/index.html
index 39521ca..6a73cb5 100644
--- a/docs/installation/setup-ssh-tunneling/index.html
+++ b/docs/installation/setup-ssh-tunneling/index.html
@@ -18,12 +18,12 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
-<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/superset-logo-horiz.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/superset-logo-horiz-dark.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Documentation</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/intro">Getting Started</a></li><li><a class="dropdown__link" href="/docs/frequently-asked-questions">FAQ</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/community">Resources</a></li><li><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">GitHub<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="http://bit.ly/join-superset-slack" target="_blank" rel="noopener noreferrer" class="dropdown__link">Slack<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://lists.apache.org/list.html?dev@superset.apache.org" target="_blank" rel="noopener noreferrer" class="dropdown__link">Mailing List<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://stackoverflow.com/questions/tagged/superset+apache-superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">Stack Overflow<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link default-button-theme get-started-button" href="/docs/intro">Get Started</a><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link github-button"></a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/intro">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/installation/installing-superset-using-docker-compose">Installation and Configuration</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/installing-superset-using-docker-compose">Installing Locally Using Docker Compose</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/installing-superset-from-scratch">Installing From Scratch</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/running-on-kubernetes">Installing on Kubernetes</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/configuring-superset">Configuring Superset</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/networking-settings">Additional Networking Settings</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/cache">Caching</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/event-logging">Event Logging</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/upgrading-superset">Upgrading Superset</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/async-queries-celery">Async Queries via Celery</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/alerts-reports">Alerts and Reports</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/sql-templating">SQL Templating</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/installation/setup-ssh-tunneling">Setup SSH Tunneling</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/databases/installing-database-drivers">Connecting to Databases</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/creating-charts-dashboards/creating-your-first-dashboard">Creating Charts and Dashboards</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/miscellaneous/country-map-tools">Miscellaneous</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/contributing/contributing-page">Contributing</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/frequently-asked-questions">Frequently Asked Questions</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api">API</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/security/">Security</a><button aria-label="Toggle the collapsible sidebar category 'Security'" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Installation and Configuration</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Setup SSH Tunneling</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h2 class="anchor anchorWithStickyNavbar_LWe7" id="ssh-tunneling">SSH Tunneling<a href="#ssh-tunneling" class="hash-link" aria-label="Direct link to SSH Tunneling" title="Direct link to SSH Tunneling"></a></h2><ol><li><p>Turn on feature flag</p><ul><li>Change <a href="https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L489" target="_blank" rel="noopener noreferrer"><code>SSH_TUNNELING</code></a> to <code>True</code></li><li>If you want to add more security when establishing the tunnel we allow users to overwrite the <code>SSHTunnelManager</code> class <a href="https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L507" target="_blank" rel="noopener noreferrer">here</a></li><li>You can also set the <a href="https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L508" target="_blank" rel="noopener noreferrer"><code>SSH_TUNNEL_LOCAL_BIND_ADDRESS</code></a> this the host address where the tunnel will be accessible on your VPC</li></ul></li><li><p>Create database w/ ssh tunnel enabled</p><ul><li>With the feature flag enabled you should now see ssh tunnel toggle.</li><li>Click the toggle to enables ssh tunneling and add your credentials accordingly.<ul><li>Superset allows for 2 different type authenticaion (Basic + Private Key). These credentials should come from your service provider.</li></ul></li></ul></li><li><p>Verify data is flowing</p><ul><li>Once SSH tunneling has been enabled, go to SQL Lab and write a query to verify data is properly flowing.</li></ul></li></ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/superset/tree/master/docs/docs/installation/setup-ssh-tunneling.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/installation/sql-templating"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">SQL Templating</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/databases/installing-database-drivers"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Installing Database Drivers</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#ssh-tunneling" class="table-of-contents__link toc-highlight">SSH Tunneling</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">
+<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/superset-logo-horiz.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/superset-logo-horiz-dark.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Documentation</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/intro">Getting Started</a></li><li><a class="dropdown__link" href="/docs/frequently-asked-questions">FAQ</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/community">Resources</a></li><li><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">GitHub<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="http://bit.ly/join-superset-slack" target="_blank" rel="noopener noreferrer" class="dropdown__link">Slack<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://lists.apache.org/list.html?dev@superset.apache.org" target="_blank" rel="noopener noreferrer" class="dropdown__link">Mailing List<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://stackoverflow.com/questions/tagged/superset+apache-superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">Stack Overflow<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link default-button-theme get-started-button" href="/docs/intro">Get Started</a><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link github-button"></a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/intro">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/installation/installing-superset-using-docker-compose">Installation and Configuration</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/installing-superset-using-docker-compose">Installing Locally Using Docker Compose</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/installing-superset-from-scratch">Installing From Scratch</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/running-on-kubernetes">Installing on Kubernetes</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/configuring-superset">Configuring Superset</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/networking-settings">Additional Networking Settings</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/cache">Caching</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/event-logging">Event Logging</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/upgrading-superset">Upgrading Superset</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/async-queries-celery">Async Queries via Celery</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/alerts-reports">Alerts and Reports</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/installation/sql-templating">SQL Templating</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/installation/setup-ssh-tunneling">Setup SSH Tunneling</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/databases/installing-database-drivers">Connecting to Databases</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/creating-charts-dashboards/creating-your-first-dashboard">Creating Charts and Dashboards</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/miscellaneous/country-map-tools">Miscellaneous</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/contributing/contributing-page">Contributing</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/frequently-asked-questions">Frequently Asked Questions</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api">API</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/security/">Security</a><button aria-label="Toggle the collapsible sidebar category 'Security'" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Installation and Configuration</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Setup SSH Tunneling</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h2 class="anchor anchorWithStickyNavbar_LWe7" id="ssh-tunneling">SSH Tunneling<a href="#ssh-tunneling" class="hash-link" aria-label="Direct link to SSH Tunneling" title="Direct link to SSH Tunneling"></a></h2><ol><li><p>Turn on feature flag</p><ul><li>Change <a href="https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L489" target="_blank" rel="noopener noreferrer"><code>SSH_TUNNELING</code></a> to <code>True</code></li><li>If you want to add more security when establishing the tunnel we allow users to overwrite the <code>SSHTunnelManager</code> class <a href="https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L507" target="_blank" rel="noopener noreferrer">here</a></li><li>You can also set the <a href="https://github.com/apache/superset/blob/eb8386e3f0647df6d1bbde8b42073850796cc16f/superset/config.py#L508" target="_blank" rel="noopener noreferrer"><code>SSH_TUNNEL_LOCAL_BIND_ADDRESS</code></a> this the host address where the tunnel will be accessible on your VPC</li></ul></li><li><p>Create database w/ ssh tunnel enabled</p><ul><li>With the feature flag enabled you should now see ssh tunnel toggle.</li><li>Click the toggle to enables ssh tunneling and add your credentials accordingly.<ul><li>Superset allows for 2 different type authentication (Basic + Private Key). These credentials should come from your service provider.</li></ul></li></ul></li><li><p>Verify data is flowing</p><ul><li>Once SSH tunneling has been enabled, go to SQL Lab and write a query to verify data is properly flowing.</li></ul></li></ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/superset/tree/master/docs/docs/installation/setup-ssh-tunneling.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/installation/sql-templating"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">SQL Templating</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/databases/installing-database-drivers"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Installing Database Drivers</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#ssh-tunneling" class="table-of-contents__link toc-highlight">SSH Tunneling</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="footer__applitools">
We use <a href="https://applitools.com/" target="_blank" rel="nofollow"><img src="/img/applitools.png" title="Applitools"></a>
</div>
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/installation/sql-templating/index.html b/docs/installation/sql-templating/index.html
index ecd3747..f03a5a2 100644
--- a/docs/installation/sql-templating/index.html
+++ b/docs/installation/sql-templating/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -80,7 +80,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/installation/upgrading-superset/index.html b/docs/installation/upgrading-superset/index.html
index 1486ac2..720956b 100644
--- a/docs/installation/upgrading-superset/index.html
+++ b/docs/installation/upgrading-superset/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -47,7 +47,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/intro/index.html b/docs/intro/index.html
index df70cd1..78fd2b5 100644
--- a/docs/intro/index.html
+++ b/docs/intro/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -57,7 +57,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/miscellaneous/chart-params/index.html b/docs/miscellaneous/chart-params/index.html
index 4be228e..e9d1d2e 100644
--- a/docs/miscellaneous/chart-params/index.html
+++ b/docs/miscellaneous/chart-params/index.html
@@ -18,12 +18,12 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
-<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/superset-logo-horiz.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/superset-logo-horiz-dark.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Documentation</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/intro">Getting Started</a></li><li><a class="dropdown__link" href="/docs/frequently-asked-questions">FAQ</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/community">Resources</a></li><li><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">GitHub<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="http://bit.ly/join-superset-slack" target="_blank" rel="noopener noreferrer" class="dropdown__link">Slack<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://lists.apache.org/list.html?dev@superset.apache.org" target="_blank" rel="noopener noreferrer" class="dropdown__link">Mailing List<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://stackoverflow.com/questions/tagged/superset+apache-superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">Stack Overflow<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link default-button-theme get-started-button" href="/docs/intro">Get Started</a><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link github-button"></a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/intro">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/installation/installing-superset-using-docker-compose">Installation and Configuration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/databases/installing-database-drivers">Connecting to Databases</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/creating-charts-dashboards/creating-your-first-dashboard">Creating Charts and Dashboards</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/miscellaneous/country-map-tools">Miscellaneous</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/miscellaneous/country-map-tools">Country Map Tools</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/miscellaneous/importing-exporting-datasources">Importing and Exporting Datasources</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/miscellaneous/issue-codes">Issue Codes</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/miscellaneous/chart-params">Chart Parameters Reference</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/miscellaneous/native-filter-migration">Migrating from Legacy to Native Filters</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/contributing/contributing-page">Contributing</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/frequently-asked-questions">Frequently Asked Questions</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api">API</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/security/">Security</a><button aria-label="Toggle the collapsible sidebar category 'Security'" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Miscellaneous</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Chart Parameters Reference</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h2 class="anchor anchorWithStickyNavbar_LWe7" id="chart-parameters">Chart Parameters<a href="#chart-parameters" class="hash-link" aria-label="Direct link to Chart Parameters" title="Direct link to Chart Parameters"></a></h2><p>Chart parameters are stored as a JSON encoded string in the <code>slices.params</code> column and are often referenced throughout the code as form-data. Currently the form-data is neither versioned nor typed as thus is somewhat free-formed. Note in the future there may be merit in using something like <a href="https://json-schema.org/" target="_blank" rel="noopener noreferrer">JSON Schema</a> to both annotate and validate the JSON object in addition to using a Mypy <code>TypedDict</code> (introduced in Python 3.8) for typing the form-data in the backend. This section serves as a potential primer for that work.</p><p>The following tables provide a non-exhaustive list of the various fields which can be present in the JSON object grouped by the Explorer pane sections. These values were obtained by extracting the distinct fields from a legacy deployment consisting of tens of thousands of charts and thus some fields may be missing whilst others may be deprecated.</p><p>Note not all fields are correctly categorized. The fields vary based on visualization type and may appear in different sections depending on the type. Verified deprecated columns may indicate a missing migration and/or prior migrations which were unsuccessful and thus future work may be required to clean up the form-data.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datasource--chart-type">Datasource & Chart Type<a href="#datasource--chart-type" class="hash-link" aria-label="Direct link to Datasource & Chart Type" title="Direct link to Datasource & Chart Type"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>database_name</code></td><td><em>string</em></td><td><em>Deprecated?</em></td></tr><tr><td><code>datasource</code></td><td><em>string</em></td><td><code><datasouce_id>__<datasource_type></code></td></tr><tr><td><code>datasource_id</code></td><td><em>string</em></td><td><em>Deprecated?</em> See <code>datasource</code></td></tr><tr><td><code>datasource_name</code></td><td><em>string</em></td><td><em>Deprecated?</em></td></tr><tr><td><code>datasource_type</code></td><td><em>string</em></td><td><em>Deprecated?</em> See <code>datasource</code></td></tr><tr><td><code>viz_type</code></td><td><em>string</em></td><td>The <strong>Visualization Type</strong> widget</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="time">Time<a href="#time" class="hash-link" aria-label="Direct link to Time" title="Direct link to Time"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>granularity_sqla</code></td><td><em>string</em></td><td>The SQLA <strong>Time Column</strong> widget</td></tr><tr><td><code>time_grain_sqla</code></td><td><em>string</em></td><td>The SQLA <strong>Time Grain</strong> widget</td></tr><tr><td><code>time_range</code></td><td><em>string</em></td><td>The <strong>Time range</strong> widget</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="group-by">GROUP BY<a href="#group-by" class="hash-link" aria-label="Direct link to GROUP BY" title="Direct link to GROUP BY"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>metrics</code></td><td><em>array(string)</em></td><td>See Query section</td></tr><tr><td><code>order_asc</code></td><td>-</td><td>See Query section</td></tr><tr><td><code>row_limit</code></td><td>-</td><td>See Query section</td></tr><tr><td><code>timeseries_limit_metric</code></td><td>-</td><td>See Query section</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="not-grouped-by">NOT GROUPED BY<a href="#not-grouped-by" class="hash-link" aria-label="Direct link to NOT GROUPED BY" title="Direct link to NOT GROUPED BY"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>order_by_cols</code></td><td><em>array(string)</em></td><td>The <strong>Ordering</strong> widget</td></tr><tr><td><code>row_limit</code></td><td>-</td><td>See Query section</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="y-axis-1">Y Axis 1<a href="#y-axis-1" class="hash-link" aria-label="Direct link to Y Axis 1" title="Direct link to Y Axis 1"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>metric</code></td><td>-</td><td>The <strong>Left Axis Metric</strong> widget. See Query section</td></tr><tr><td><code>y_axis_format</code></td><td>-</td><td>See Y Axis section</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="y-axis-2">Y Axis 2<a href="#y-axis-2" class="hash-link" aria-label="Direct link to Y Axis 2" title="Direct link to Y Axis 2"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>metric_2</code></td><td>-</td><td>The <strong>Right Axis Metric</strong> widget. See Query section</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="query">Query<a href="#query" class="hash-link" aria-label="Direct link to Query" title="Direct link to Query"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>adhoc_filters</code></td><td><em>array(object)</em></td><td>The <strong>Filters</strong> widget</td></tr><tr><td><code>extra_filters</code></td><td><em>array(object)</em></td><td>Another pathway to the <strong>Filters</strong> widget.<br>It is generally used to pass dashboard filter parameters to a chart.<br>It can be used for appending additional filters to a chart that has been saved with its own filters on an ad-hoc basis if the chart is being used as a standalone widget.<br><br>For implementation examples see : <a href="https://github.com/apache/superset/blob/66a4c94a1ed542e69fe6399bab4c01d4540486cf/tests/utils_tests.py#L181" target="_blank" rel="noopener noreferrer">utils test.py</a><br>For insight into how superset processes the contents of this parameter see: <a href="https://github.com/apache/superset/blob/93c7f5bb446ec6895d7702835f3157426955d5a9/superset-frontend/src/explore/exploreUtils/index.js#L159" target="_blank" rel="noopener noreferrer">exploreUtils/index.js</a></td></tr><tr><td><code>columns</code></td><td><em>array(string)</em></td><td>The <strong>Breakdowns</strong> widget</td></tr><tr><td><code>groupby</code></td><td><em>array(string)</em></td><td>The <strong>Group by</strong> or <strong>Series</strong> widget</td></tr><tr><td><code>limit</code></td><td><em>number</em></td><td>The <strong>Series Limit</strong> widget</td></tr><tr><td><code>metric</code><br><code>metric_2</code><br><code>metrics</code><br><code>percent_metrics</code><br><code>secondary_metric</code><br><code>size</code><br><code>x</code><br><code>y</code></td><td><em>string</em>,<em>object</em>,<em>array(string)</em>,<em>array(object)</em></td><td>The metric(s) depending on the visualization type</td></tr><tr><td><code>order_asc</code></td><td><em>boolean</em></td><td>The <strong>Sort Descending</strong> widget</td></tr><tr><td><code>row_limit</code></td><td><em>number</em></td><td>The <strong>Row limit</strong> widget</td></tr><tr><td><code>timeseries_limit_metric</code></td><td><em>object</em></td><td>The <strong>Sort By</strong> widget</td></tr></tbody></table><p>The <code>metric</code> (or equivalent) and <code>timeseries_limit_metric</code> fields are all composed of either metric names or the JSON representation of the <code>AdhocMetric</code> TypeScript type. The <code>adhoc_filters</code> is composed of the JSON represent of the <code>AdhocFilter</code> TypeScript type (which can comprise of columns or metrics depending on whether it is a WHERE or HAVING clause). The <code>all_columns</code>, <code>all_columns_x</code>, <code>columns</code>, <code>groupby</code>, and <code>order_by_cols</code> fields all represent column names.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="chart-options">Chart Options<a href="#chart-options" class="hash-link" aria-label="Direct link to Chart Options" title="Direct link to Chart Options"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>color_picker</code></td><td><em>object</em></td><td>The <strong>Fixed Color</strong> widget</td></tr><tr><td><code>label_colors</code></td><td><em>object</em></td><td>The <strong>Color Scheme</strong> widget</td></tr><tr><td><code>normalized</code></td><td><em>boolean</em></td><td>The <strong>Normalized</strong> widget</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="y-axis">Y Axis<a href="#y-axis" class="hash-link" aria-label="Direct link to Y Axis" title="Direct link to Y Axis"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>y_axis_2_label</code></td><td><em>N/A</em></td><td><em>Deprecated?</em></td></tr><tr><td><code>y_axis_format</code></td><td><em>string</em></td><td>The <strong>Y Axis Format</strong> widget</td></tr><tr><td><code>y_axis_zero</code></td><td><em>N/A</em></td><td><em>Deprecated?</em></td></tr></tbody></table><p>Note the <code>y_axis_format</code> is defined under various section for some charts.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="other">Other<a href="#other" class="hash-link" aria-label="Direct link to Other" title="Direct link to Other"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>color_scheme</code></td><td><em>string</em></td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="unclassified">Unclassified<a href="#unclassified" class="hash-link" aria-label="Direct link to Unclassified" title="Direct link to Unclassified"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>add_to_dash</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>code</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>collapsed_fieldsets</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>comparison type</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>country_fieldtype</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>default_filters</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>entity</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>expanded_slices</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>filter_immune_slice_fields</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>filter_immune_slices</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>flt_col_0</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>flt_col_1</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>flt_eq_0</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>flt_eq_1</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>flt_op_0</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>flt_op_1</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>goto_dash</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>import_time</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>label</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>linear_color_scheme</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>new_dashboard_name</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>new_slice_name</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>num_period_compare</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>period_ratio_type</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>perm</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>rdo_save</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>refresh_frequency</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>remote_id</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>resample_fillmethod</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>resample_how</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>rose_area_proportion</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>save_to_dashboard_id</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>schema</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>series</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>show_bubbles</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>slice_name</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>timed_refresh_immune_slices</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>userid</code></td><td><em>N/A</em></td><td></td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/superset/tree/master/docs/docs/miscellaneous/chart-params.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/miscellaneous/issue-codes"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Issue Codes</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/miscellaneous/native-filter-migration"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Migrating from Legacy to Native Filters</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#chart-parameters" class="table-of-contents__link toc-highlight">Chart Parameters</a><ul><li><a href="#datasource--chart-type" class="table-of-contents__link toc-highlight">Datasource & Chart Type</a></li><li><a href="#time" class="table-of-contents__link toc-highlight">Time</a></li><li><a href="#group-by" class="table-of-contents__link toc-highlight">GROUP BY</a></li><li><a href="#not-grouped-by" class="table-of-contents__link toc-highlight">NOT GROUPED BY</a></li><li><a href="#y-axis-1" class="table-of-contents__link toc-highlight">Y Axis 1</a></li><li><a href="#y-axis-2" class="table-of-contents__link toc-highlight">Y Axis 2</a></li><li><a href="#query" class="table-of-contents__link toc-highlight">Query</a></li><li><a href="#chart-options" class="table-of-contents__link toc-highlight">Chart Options</a></li><li><a href="#y-axis" class="table-of-contents__link toc-highlight">Y Axis</a></li><li><a href="#other" class="table-of-contents__link toc-highlight">Other</a></li><li><a href="#unclassified" class="table-of-contents__link toc-highlight">Unclassified</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">
+<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/superset-logo-horiz.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/superset-logo-horiz-dark.svg" alt="Superset Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Documentation</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/intro">Getting Started</a></li><li><a class="dropdown__link" href="/docs/frequently-asked-questions">FAQ</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/community">Resources</a></li><li><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">GitHub<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="http://bit.ly/join-superset-slack" target="_blank" rel="noopener noreferrer" class="dropdown__link">Slack<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://lists.apache.org/list.html?dev@superset.apache.org" target="_blank" rel="noopener noreferrer" class="dropdown__link">Mailing List<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://stackoverflow.com/questions/tagged/superset+apache-superset" target="_blank" rel="noopener noreferrer" class="dropdown__link">Stack Overflow<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link default-button-theme get-started-button" href="/docs/intro">Get Started</a><a href="https://github.com/apache/superset" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link github-button"></a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/intro">Introduction</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/installation/installing-superset-using-docker-compose">Installation and Configuration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/databases/installing-database-drivers">Connecting to Databases</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/creating-charts-dashboards/creating-your-first-dashboard">Creating Charts and Dashboards</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/miscellaneous/country-map-tools">Miscellaneous</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/miscellaneous/country-map-tools">Country Map Tools</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/miscellaneous/importing-exporting-datasources">Importing and Exporting Datasources</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/miscellaneous/issue-codes">Issue Codes</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/miscellaneous/chart-params">Chart Parameters Reference</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/miscellaneous/native-filter-migration">Migrating from Legacy to Native Filters</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/contributing/contributing-page">Contributing</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/frequently-asked-questions">Frequently Asked Questions</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/api">API</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/security/">Security</a><button aria-label="Toggle the collapsible sidebar category 'Security'" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Miscellaneous</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Chart Parameters Reference</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h2 class="anchor anchorWithStickyNavbar_LWe7" id="chart-parameters">Chart Parameters<a href="#chart-parameters" class="hash-link" aria-label="Direct link to Chart Parameters" title="Direct link to Chart Parameters"></a></h2><p>Chart parameters are stored as a JSON encoded string in the <code>slices.params</code> column and are often referenced throughout the code as form-data. Currently the form-data is neither versioned nor typed as thus is somewhat free-formed. Note in the future there may be merit in using something like <a href="https://json-schema.org/" target="_blank" rel="noopener noreferrer">JSON Schema</a> to both annotate and validate the JSON object in addition to using a Mypy <code>TypedDict</code> (introduced in Python 3.8) for typing the form-data in the backend. This section serves as a potential primer for that work.</p><p>The following tables provide a non-exhaustive list of the various fields which can be present in the JSON object grouped by the Explorer pane sections. These values were obtained by extracting the distinct fields from a legacy deployment consisting of tens of thousands of charts and thus some fields may be missing whilst others may be deprecated.</p><p>Note not all fields are correctly categorized. The fields vary based on visualization type and may appear in different sections depending on the type. Verified deprecated columns may indicate a missing migration and/or prior migrations which were unsuccessful and thus future work may be required to clean up the form-data.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="datasource--chart-type">Datasource & Chart Type<a href="#datasource--chart-type" class="hash-link" aria-label="Direct link to Datasource & Chart Type" title="Direct link to Datasource & Chart Type"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>database_name</code></td><td><em>string</em></td><td><em>Deprecated?</em></td></tr><tr><td><code>datasource</code></td><td><em>string</em></td><td><code><datasource_id>__<datasource_type></code></td></tr><tr><td><code>datasource_id</code></td><td><em>string</em></td><td><em>Deprecated?</em> See <code>datasource</code></td></tr><tr><td><code>datasource_name</code></td><td><em>string</em></td><td><em>Deprecated?</em></td></tr><tr><td><code>datasource_type</code></td><td><em>string</em></td><td><em>Deprecated?</em> See <code>datasource</code></td></tr><tr><td><code>viz_type</code></td><td><em>string</em></td><td>The <strong>Visualization Type</strong> widget</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="time">Time<a href="#time" class="hash-link" aria-label="Direct link to Time" title="Direct link to Time"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>granularity_sqla</code></td><td><em>string</em></td><td>The SQLA <strong>Time Column</strong> widget</td></tr><tr><td><code>time_grain_sqla</code></td><td><em>string</em></td><td>The SQLA <strong>Time Grain</strong> widget</td></tr><tr><td><code>time_range</code></td><td><em>string</em></td><td>The <strong>Time range</strong> widget</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="group-by">GROUP BY<a href="#group-by" class="hash-link" aria-label="Direct link to GROUP BY" title="Direct link to GROUP BY"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>metrics</code></td><td><em>array(string)</em></td><td>See Query section</td></tr><tr><td><code>order_asc</code></td><td>-</td><td>See Query section</td></tr><tr><td><code>row_limit</code></td><td>-</td><td>See Query section</td></tr><tr><td><code>timeseries_limit_metric</code></td><td>-</td><td>See Query section</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="not-grouped-by">NOT GROUPED BY<a href="#not-grouped-by" class="hash-link" aria-label="Direct link to NOT GROUPED BY" title="Direct link to NOT GROUPED BY"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>order_by_cols</code></td><td><em>array(string)</em></td><td>The <strong>Ordering</strong> widget</td></tr><tr><td><code>row_limit</code></td><td>-</td><td>See Query section</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="y-axis-1">Y Axis 1<a href="#y-axis-1" class="hash-link" aria-label="Direct link to Y Axis 1" title="Direct link to Y Axis 1"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>metric</code></td><td>-</td><td>The <strong>Left Axis Metric</strong> widget. See Query section</td></tr><tr><td><code>y_axis_format</code></td><td>-</td><td>See Y Axis section</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="y-axis-2">Y Axis 2<a href="#y-axis-2" class="hash-link" aria-label="Direct link to Y Axis 2" title="Direct link to Y Axis 2"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>metric_2</code></td><td>-</td><td>The <strong>Right Axis Metric</strong> widget. See Query section</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="query">Query<a href="#query" class="hash-link" aria-label="Direct link to Query" title="Direct link to Query"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>adhoc_filters</code></td><td><em>array(object)</em></td><td>The <strong>Filters</strong> widget</td></tr><tr><td><code>extra_filters</code></td><td><em>array(object)</em></td><td>Another pathway to the <strong>Filters</strong> widget.<br>It is generally used to pass dashboard filter parameters to a chart.<br>It can be used for appending additional filters to a chart that has been saved with its own filters on an ad-hoc basis if the chart is being used as a standalone widget.<br><br>For implementation examples see : <a href="https://github.com/apache/superset/blob/66a4c94a1ed542e69fe6399bab4c01d4540486cf/tests/utils_tests.py#L181" target="_blank" rel="noopener noreferrer">utils test.py</a><br>For insight into how superset processes the contents of this parameter see: <a href="https://github.com/apache/superset/blob/93c7f5bb446ec6895d7702835f3157426955d5a9/superset-frontend/src/explore/exploreUtils/index.js#L159" target="_blank" rel="noopener noreferrer">exploreUtils/index.js</a></td></tr><tr><td><code>columns</code></td><td><em>array(string)</em></td><td>The <strong>Breakdowns</strong> widget</td></tr><tr><td><code>groupby</code></td><td><em>array(string)</em></td><td>The <strong>Group by</strong> or <strong>Series</strong> widget</td></tr><tr><td><code>limit</code></td><td><em>number</em></td><td>The <strong>Series Limit</strong> widget</td></tr><tr><td><code>metric</code><br><code>metric_2</code><br><code>metrics</code><br><code>percent_metrics</code><br><code>secondary_metric</code><br><code>size</code><br><code>x</code><br><code>y</code></td><td><em>string</em>,<em>object</em>,<em>array(string)</em>,<em>array(object)</em></td><td>The metric(s) depending on the visualization type</td></tr><tr><td><code>order_asc</code></td><td><em>boolean</em></td><td>The <strong>Sort Descending</strong> widget</td></tr><tr><td><code>row_limit</code></td><td><em>number</em></td><td>The <strong>Row limit</strong> widget</td></tr><tr><td><code>timeseries_limit_metric</code></td><td><em>object</em></td><td>The <strong>Sort By</strong> widget</td></tr></tbody></table><p>The <code>metric</code> (or equivalent) and <code>timeseries_limit_metric</code> fields are all composed of either metric names or the JSON representation of the <code>AdhocMetric</code> TypeScript type. The <code>adhoc_filters</code> is composed of the JSON represent of the <code>AdhocFilter</code> TypeScript type (which can comprise of columns or metrics depending on whether it is a WHERE or HAVING clause). The <code>all_columns</code>, <code>all_columns_x</code>, <code>columns</code>, <code>groupby</code>, and <code>order_by_cols</code> fields all represent column names.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="chart-options">Chart Options<a href="#chart-options" class="hash-link" aria-label="Direct link to Chart Options" title="Direct link to Chart Options"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>color_picker</code></td><td><em>object</em></td><td>The <strong>Fixed Color</strong> widget</td></tr><tr><td><code>label_colors</code></td><td><em>object</em></td><td>The <strong>Color Scheme</strong> widget</td></tr><tr><td><code>normalized</code></td><td><em>boolean</em></td><td>The <strong>Normalized</strong> widget</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="y-axis">Y Axis<a href="#y-axis" class="hash-link" aria-label="Direct link to Y Axis" title="Direct link to Y Axis"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>y_axis_2_label</code></td><td><em>N/A</em></td><td><em>Deprecated?</em></td></tr><tr><td><code>y_axis_format</code></td><td><em>string</em></td><td>The <strong>Y Axis Format</strong> widget</td></tr><tr><td><code>y_axis_zero</code></td><td><em>N/A</em></td><td><em>Deprecated?</em></td></tr></tbody></table><p>Note the <code>y_axis_format</code> is defined under various section for some charts.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="other">Other<a href="#other" class="hash-link" aria-label="Direct link to Other" title="Direct link to Other"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>color_scheme</code></td><td><em>string</em></td><td></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="unclassified">Unclassified<a href="#unclassified" class="hash-link" aria-label="Direct link to Unclassified" title="Direct link to Unclassified"></a></h3><table><thead><tr><th>Field</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>add_to_dash</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>code</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>collapsed_fieldsets</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>comparison type</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>country_fieldtype</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>default_filters</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>entity</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>expanded_slices</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>filter_immune_slice_fields</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>filter_immune_slices</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>flt_col_0</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>flt_col_1</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>flt_eq_0</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>flt_eq_1</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>flt_op_0</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>flt_op_1</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>goto_dash</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>import_time</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>label</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>linear_color_scheme</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>new_dashboard_name</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>new_slice_name</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>num_period_compare</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>period_ratio_type</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>perm</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>rdo_save</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>refresh_frequency</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>remote_id</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>resample_fillmethod</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>resample_how</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>rose_area_proportion</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>save_to_dashboard_id</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>schema</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>series</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>show_bubbles</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>slice_name</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>timed_refresh_immune_slices</code></td><td><em>N/A</em></td><td></td></tr><tr><td><code>userid</code></td><td><em>N/A</em></td><td></td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/superset/tree/master/docs/docs/miscellaneous/chart-params.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/miscellaneous/issue-codes"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Issue Codes</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/miscellaneous/native-filter-migration"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Migrating from Legacy to Native Filters</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#chart-parameters" class="table-of-contents__link toc-highlight">Chart Parameters</a><ul><li><a href="#datasource--chart-type" class="table-of-contents__link toc-highlight">Datasource & Chart Type</a></li><li><a href="#time" class="table-of-contents__link toc-highlight">Time</a></li><li><a href="#group-by" class="table-of-contents__link toc-highlight">GROUP BY</a></li><li><a href="#not-grouped-by" class="table-of-contents__link toc-highlight">NOT GROUPED BY</a></li><li><a href="#y-axis-1" class="table-of-contents__link toc-highlight">Y Axis 1</a></li><li><a href="#y-axis-2" class="table-of-contents__link toc-highlight">Y Axis 2</a></li><li><a href="#query" class="table-of-contents__link toc-highlight">Query</a></li><li><a href="#chart-options" class="table-of-contents__link toc-highlight">Chart Options</a></li><li><a href="#y-axis" class="table-of-contents__link toc-highlight">Y Axis</a></li><li><a href="#other" class="table-of-contents__link toc-highlight">Other</a></li><li><a href="#unclassified" class="table-of-contents__link toc-highlight">Unclassified</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="footer__applitools">
We use <a href="https://applitools.com/" target="_blank" rel="nofollow"><img src="/img/applitools.png" title="Applitools"></a>
</div>
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/miscellaneous/country-map-tools/index.html b/docs/miscellaneous/country-map-tools/index.html
index 9efb8a3..8ad4782 100644
--- a/docs/miscellaneous/country-map-tools/index.html
+++ b/docs/miscellaneous/country-map-tools/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -51,7 +51,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/miscellaneous/importing-exporting-datasources/index.html b/docs/miscellaneous/importing-exporting-datasources/index.html
index e3bfbb7..91f2cd0 100644
--- a/docs/miscellaneous/importing-exporting-datasources/index.html
+++ b/docs/miscellaneous/importing-exporting-datasources/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -56,7 +56,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/miscellaneous/issue-codes/index.html b/docs/miscellaneous/issue-codes/index.html
index 5a85306..10a889e 100644
--- a/docs/miscellaneous/issue-codes/index.html
+++ b/docs/miscellaneous/issue-codes/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -52,7 +52,7 @@
to your administrator.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1012">Issue 1012<a href="#issue-1012" class="hash-link" aria-label="Direct link to Issue 1012" title="Direct link to Issue 1012"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The username provided when connecting to a database is not valid.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The user provided a username that doesn't exist in the database. Please check
that the username is typed correctly and exists in the database.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1013">Issue 1013<a href="#issue-1013" class="hash-link" aria-label="Direct link to Issue 1013" title="Direct link to Issue 1013"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The password provided when connecting to a database is not valid.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The user provided a password that is incorrect. Please check that the
password is typed correctly.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1014">Issue 1014<a href="#issue-1014" class="hash-link" aria-label="Direct link to Issue 1014" title="Direct link to Issue 1014"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Either the username or the password used are incorrect.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Either the username provided does not exist or the password was written incorrectly. Please
-check that the username and password were typed correctly.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1015">Issue 1015<a href="#issue-1015" class="hash-link" aria-label="Direct link to Issue 1015" title="Direct link to Issue 1015"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Either the database is spelled incorrectly or does not exist.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Either the database was written incorrectly or it does not exist. Check that it was typed correctly.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1016">Issue 1016<a href="#issue-1016" class="hash-link" aria-label="Direct link to Issue 1016" title="Direct link to Issue 1016"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The schema was deleted or renamed in the database.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The schema was either removed or renamed. Check that the schema is typed correctly and exists.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1017">Issue 1017<a href="#issue-1017" class="hash-link" aria-label="Direct link to Issue 1017" title="Direct link to Issue 1017"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The user doesn't have the proper permissions to connect to the database</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>We were unable to connect to your database. Please confirm that your service account has the Viewer and Job User roles on the project.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1018">Issue 1018<a href="#issue-1018" class="hash-link" aria-label="Direct link to Issue 1018" title="Direct link to Issue 1018"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">One or more parameters needed to configure a database are missing.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Not all parameters required to test, create, or edit a database were present. Please double check which parameters are needed, and that they are present.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1019">Issue 1019<a href="#issue-1019" class="hash-link" aria-label="Direct link to Issue 1019" title="Direct link to Issue 1019"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The submitted payload has the incorrect format.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Please check that the request payload has the correct format (eg, JSON).</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1020">Issue 1020<a href="#issue-1020" class="hash-link" aria-label="Direct link to Issue 1020" title="Direct link to Issue 1020"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The submitted payload has the incorrect schema.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Please check that the request payload has the expected schema.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1021">Issue 1021<a href="#issue-1021" class="hash-link" aria-label="Direct link to Issue 1021" title="Direct link to Issue 1021"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Results backend needed for asynchronous queries is not configured.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Your instance of Superset doesn't have a results backend configured, which is needed for asynchronous queries. Please contact an administrator for further assistance.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1022">Issue 1022<a href="#issue-1022" class="hash-link" aria-label="Direct link to Issue 1022" title="Direct link to Issue 1022"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Database does not allow data manipulation.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Only <code>SELECT</code> statements are allowed against this database. Please contact an administrator if you need to run DML (data manipulation language) on this database.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1023">Issue 1023<a href="#issue-1023" class="hash-link" aria-label="Direct link to Issue 1023" title="Direct link to Issue 1023"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">CTAS (create table as select) doesn't have a SELECT statement at the end.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The last statement in a query run as CTAS (create table as select) MUST be a SELECT statement. Please make sure the last statement in the query is a SELECT.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1024">Issue 1024<a href="#issue-1024" class="hash-link" aria-label="Direct link to Issue 1024" title="Direct link to Issue 1024"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">CVAS (create view as select) query has more than one statement.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>When running a CVAS (create view as select) the query should have a single statement. Please make sure the query has a single statement, and no extra semi-colons other than the last one.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1025">Issue 1025<a href="#issue-1025" class="hash-link" aria-label="Direct link to Issue 1025" title="Direct link to Issue 1025"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">CVAS (create view as select) query is not a SELECT statement.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>When running a CVAS (create view as select) the query should be a SELECT statement. Please make sure the query has a single statement and it's a SELECT statement.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1026">Issue 1026<a href="#issue-1026" class="hash-link" aria-label="Direct link to Issue 1026" title="Direct link to Issue 1026"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Query is too complex and takes too long to run.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The submitted query might be too complex to run under the time limit defined by your Superset administrator. Please double check your query and verify if it can be optimized. Alternatively, contact your administrator to increase the timeout period.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1027">Issue 1027<a href="#issue-1027" class="hash-link" aria-label="Direct link to Issue 1027" title="Direct link to Issue 1027"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The database is currently running too many queries.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The database might be under heavy load, running too many queries. Please try again later, or contact an administrator for further assistance.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1028">Issue 1028<a href="#issue-1028" class="hash-link" aria-label="Direct link to Issue 1028" title="Direct link to Issue 1028"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">One or more parameters specified in the query are malformatted.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The query contains one or more malformed template parameters. Please check your query and confirm that all template parameters are surround by double braces, for example, "{{ ds }}". Then, try running your query again.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1029">Issue 1029<a href="#issue-1029" class="hash-link" aria-label="Direct link to Issue 1029" title="Direct link to Issue 1029"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The object does not exist in this database.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Either the schema, column, or table do not exist in the database.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1030">Issue 1030<a href="#issue-1030" class="hash-link" aria-label="Direct link to Issue 1030" title="Direct link to Issue 1030"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The query potentially has a syntax error.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The query might have a syntax error. Please check and run again.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1031">Issue 1031<a href="#issue-1031" class="hash-link" aria-label="Direct link to Issue 1031" title="Direct link to Issue 1031"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The results backend no longer has the data from the query.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The results from the query might have been deleted from the results backend after some period. Please re-run your query.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1032">Issue 1032<a href="#issue-1032" class="hash-link" aria-label="Direct link to Issue 1032" title="Direct link to Issue 1032"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The query associated with the results was deleted.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The query associated with the stored results no longer exists. Please re-run your query.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1033">Issue 1033<a href="#issue-1033" class="hash-link" aria-label="Direct link to Issue 1033" title="Direct link to Issue 1033"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The results stored in the backend were stored in a different format, and no longer can be deserialized.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The query results were stored in a format that is no longer supported. Please re-run your query.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1034">Issue 1034<a href="#issue-1034" class="hash-link" aria-label="Direct link to Issue 1034" title="Direct link to Issue 1034"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The database port provided is invalid.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Please check that the provided database port is an integer between 0 and 65535 (inclusive).</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1035">Issue 1035<a href="#issue-1035" class="hash-link" aria-label="Direct link to Issue 1035" title="Direct link to Issue 1035"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Failed to start remote query on a worker.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The query was not started by an asynchronous worker. Please reach out to your administrator for further assistance.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1036">Issue 1036<a href="#issue-1036" class="hash-link" aria-label="Direct link to Issue 1036" title="Direct link to Issue 1036"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The database was deleted.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The operation failed because the database referenced no longer exists. Please reach out to your administrator for further assistance.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/superset/tree/master/docs/docs/miscellaneous/issue-codes.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/miscellaneous/importing-exporting-datasources"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Importing and Exporting Datasources</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/miscellaneous/chart-params"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Chart Parameters Reference</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#issue-1000" class="table-of-contents__link toc-highlight">Issue 1000</a></li><li><a href="#issue-1001" class="table-of-contents__link toc-highlight">Issue 1001</a></li><li><a href="#issue-1002" class="table-of-contents__link toc-highlight">Issue 1002</a></li><li><a href="#issue-1003" class="table-of-contents__link toc-highlight">Issue 1003</a></li><li><a href="#issue-1004" class="table-of-contents__link toc-highlight">Issue 1004</a></li><li><a href="#issue-1005" class="table-of-contents__link toc-highlight">Issue 1005</a></li><li><a href="#issue-1006" class="table-of-contents__link toc-highlight">Issue 1006</a></li><li><a href="#issue-1007" class="table-of-contents__link toc-highlight">Issue 1007</a></li><li><a href="#issue-1008" class="table-of-contents__link toc-highlight">Issue 1008</a></li><li><a href="#issue-1009" class="table-of-contents__link toc-highlight">Issue 1009</a></li><li><a href="#issue-1010" class="table-of-contents__link toc-highlight">Issue 1010</a></li><li><a href="#issue-1011" class="table-of-contents__link toc-highlight">Issue 1011</a></li><li><a href="#issue-1012" class="table-of-contents__link toc-highlight">Issue 1012</a></li><li><a href="#issue-1013" class="table-of-contents__link toc-highlight">Issue 1013</a></li><li><a href="#issue-1014" class="table-of-contents__link toc-highlight">Issue 1014</a></li><li><a href="#issue-1015" class="table-of-contents__link toc-highlight">Issue 1015</a></li><li><a href="#issue-1016" class="table-of-contents__link toc-highlight">Issue 1016</a></li><li><a href="#issue-1017" class="table-of-contents__link toc-highlight">Issue 1017</a></li><li><a href="#issue-1018" class="table-of-contents__link toc-highlight">Issue 1018</a></li><li><a href="#issue-1019" class="table-of-contents__link toc-highlight">Issue 1019</a></li><li><a href="#issue-1020" class="table-of-contents__link toc-highlight">Issue 1020</a></li><li><a href="#issue-1021" class="table-of-contents__link toc-highlight">Issue 1021</a></li><li><a href="#issue-1022" class="table-of-contents__link toc-highlight">Issue 1022</a></li><li><a href="#issue-1023" class="table-of-contents__link toc-highlight">Issue 1023</a></li><li><a href="#issue-1024" class="table-of-contents__link toc-highlight">Issue 1024</a></li><li><a href="#issue-1025" class="table-of-contents__link toc-highlight">Issue 1025</a></li><li><a href="#issue-1026" class="table-of-contents__link toc-highlight">Issue 1026</a></li><li><a href="#issue-1027" class="table-of-contents__link toc-highlight">Issue 1027</a></li><li><a href="#issue-1028" class="table-of-contents__link toc-highlight">Issue 1028</a></li><li><a href="#issue-1029" class="table-of-contents__link toc-highlight">Issue 1029</a></li><li><a href="#issue-1030" class="table-of-contents__link toc-highlight">Issue 1030</a></li><li><a href="#issue-1031" class="table-of-contents__link toc-highlight">Issue 1031</a></li><li><a href="#issue-1032" class="table-of-contents__link toc-highlight">Issue 1032</a></li><li><a href="#issue-1033" class="table-of-contents__link toc-highlight">Issue 1033</a></li><li><a href="#issue-1034" class="table-of-contents__link toc-highlight">Issue 1034</a></li><li><a href="#issue-1035" class="table-of-contents__link toc-highlight">Issue 1035</a></li><li><a href="#issue-1036" class="table-of-contents__link toc-highlight">Issue 1036</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">
+check that the username and password were typed correctly.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1015">Issue 1015<a href="#issue-1015" class="hash-link" aria-label="Direct link to Issue 1015" title="Direct link to Issue 1015"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Either the database is spelled incorrectly or does not exist.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Either the database was written incorrectly or it does not exist. Check that it was typed correctly.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1016">Issue 1016<a href="#issue-1016" class="hash-link" aria-label="Direct link to Issue 1016" title="Direct link to Issue 1016"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The schema was deleted or renamed in the database.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The schema was either removed or renamed. Check that the schema is typed correctly and exists.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1017">Issue 1017<a href="#issue-1017" class="hash-link" aria-label="Direct link to Issue 1017" title="Direct link to Issue 1017"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The user doesn't have the proper permissions to connect to the database</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>We were unable to connect to your database. Please confirm that your service account has the Viewer and Job User roles on the project.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1018">Issue 1018<a href="#issue-1018" class="hash-link" aria-label="Direct link to Issue 1018" title="Direct link to Issue 1018"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">One or more parameters needed to configure a database are missing.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Not all parameters required to test, create, or edit a database were present. Please double check which parameters are needed, and that they are present.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1019">Issue 1019<a href="#issue-1019" class="hash-link" aria-label="Direct link to Issue 1019" title="Direct link to Issue 1019"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The submitted payload has the incorrect format.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Please check that the request payload has the correct format (eg, JSON).</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1020">Issue 1020<a href="#issue-1020" class="hash-link" aria-label="Direct link to Issue 1020" title="Direct link to Issue 1020"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The submitted payload has the incorrect schema.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Please check that the request payload has the expected schema.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1021">Issue 1021<a href="#issue-1021" class="hash-link" aria-label="Direct link to Issue 1021" title="Direct link to Issue 1021"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Results backend needed for asynchronous queries is not configured.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Your instance of Superset doesn't have a results backend configured, which is needed for asynchronous queries. Please contact an administrator for further assistance.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1022">Issue 1022<a href="#issue-1022" class="hash-link" aria-label="Direct link to Issue 1022" title="Direct link to Issue 1022"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Database does not allow data manipulation.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Only <code>SELECT</code> statements are allowed against this database. Please contact an administrator if you need to run DML (data manipulation language) on this database.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1023">Issue 1023<a href="#issue-1023" class="hash-link" aria-label="Direct link to Issue 1023" title="Direct link to Issue 1023"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">CTAS (create table as select) doesn't have a SELECT statement at the end.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The last statement in a query run as CTAS (create table as select) MUST be a SELECT statement. Please make sure the last statement in the query is a SELECT.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1024">Issue 1024<a href="#issue-1024" class="hash-link" aria-label="Direct link to Issue 1024" title="Direct link to Issue 1024"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">CVAS (create view as select) query has more than one statement.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>When running a CVAS (create view as select) the query should have a single statement. Please make sure the query has a single statement, and no extra semi-colons other than the last one.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1025">Issue 1025<a href="#issue-1025" class="hash-link" aria-label="Direct link to Issue 1025" title="Direct link to Issue 1025"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">CVAS (create view as select) query is not a SELECT statement.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>When running a CVAS (create view as select) the query should be a SELECT statement. Please make sure the query has a single statement and it's a SELECT statement.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1026">Issue 1026<a href="#issue-1026" class="hash-link" aria-label="Direct link to Issue 1026" title="Direct link to Issue 1026"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Query is too complex and takes too long to run.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The submitted query might be too complex to run under the time limit defined by your Superset administrator. Please double check your query and verify if it can be optimized. Alternatively, contact your administrator to increase the timeout period.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1027">Issue 1027<a href="#issue-1027" class="hash-link" aria-label="Direct link to Issue 1027" title="Direct link to Issue 1027"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The database is currently running too many queries.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The database might be under heavy load, running too many queries. Please try again later, or contact an administrator for further assistance.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1028">Issue 1028<a href="#issue-1028" class="hash-link" aria-label="Direct link to Issue 1028" title="Direct link to Issue 1028"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">One or more parameters specified in the query are malformed.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The query contains one or more malformed template parameters. Please check your query and confirm that all template parameters are surround by double braces, for example, "{{ ds }}". Then, try running your query again.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1029">Issue 1029<a href="#issue-1029" class="hash-link" aria-label="Direct link to Issue 1029" title="Direct link to Issue 1029"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The object does not exist in this database.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Either the schema, column, or table do not exist in the database.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1030">Issue 1030<a href="#issue-1030" class="hash-link" aria-label="Direct link to Issue 1030" title="Direct link to Issue 1030"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The query potentially has a syntax error.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The query might have a syntax error. Please check and run again.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1031">Issue 1031<a href="#issue-1031" class="hash-link" aria-label="Direct link to Issue 1031" title="Direct link to Issue 1031"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The results backend no longer has the data from the query.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The results from the query might have been deleted from the results backend after some period. Please re-run your query.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1032">Issue 1032<a href="#issue-1032" class="hash-link" aria-label="Direct link to Issue 1032" title="Direct link to Issue 1032"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The query associated with the results was deleted.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The query associated with the stored results no longer exists. Please re-run your query.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1033">Issue 1033<a href="#issue-1033" class="hash-link" aria-label="Direct link to Issue 1033" title="Direct link to Issue 1033"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The results stored in the backend were stored in a different format, and no longer can be deserialized.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The query results were stored in a format that is no longer supported. Please re-run your query.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1034">Issue 1034<a href="#issue-1034" class="hash-link" aria-label="Direct link to Issue 1034" title="Direct link to Issue 1034"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The database port provided is invalid.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Please check that the provided database port is an integer between 0 and 65535 (inclusive).</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1035">Issue 1035<a href="#issue-1035" class="hash-link" aria-label="Direct link to Issue 1035" title="Direct link to Issue 1035"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">Failed to start remote query on a worker.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The query was not started by an asynchronous worker. Please reach out to your administrator for further assistance.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="issue-1036">Issue 1036<a href="#issue-1036" class="hash-link" aria-label="Direct link to Issue 1036" title="Direct link to Issue 1036"></a></h2><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">The database was deleted.</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>The operation failed because the database referenced no longer exists. Please reach out to your administrator for further assistance.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/superset/tree/master/docs/docs/miscellaneous/issue-codes.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/miscellaneous/importing-exporting-datasources"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Importing and Exporting Datasources</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/miscellaneous/chart-params"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Chart Parameters Reference</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#issue-1000" class="table-of-contents__link toc-highlight">Issue 1000</a></li><li><a href="#issue-1001" class="table-of-contents__link toc-highlight">Issue 1001</a></li><li><a href="#issue-1002" class="table-of-contents__link toc-highlight">Issue 1002</a></li><li><a href="#issue-1003" class="table-of-contents__link toc-highlight">Issue 1003</a></li><li><a href="#issue-1004" class="table-of-contents__link toc-highlight">Issue 1004</a></li><li><a href="#issue-1005" class="table-of-contents__link toc-highlight">Issue 1005</a></li><li><a href="#issue-1006" class="table-of-contents__link toc-highlight">Issue 1006</a></li><li><a href="#issue-1007" class="table-of-contents__link toc-highlight">Issue 1007</a></li><li><a href="#issue-1008" class="table-of-contents__link toc-highlight">Issue 1008</a></li><li><a href="#issue-1009" class="table-of-contents__link toc-highlight">Issue 1009</a></li><li><a href="#issue-1010" class="table-of-contents__link toc-highlight">Issue 1010</a></li><li><a href="#issue-1011" class="table-of-contents__link toc-highlight">Issue 1011</a></li><li><a href="#issue-1012" class="table-of-contents__link toc-highlight">Issue 1012</a></li><li><a href="#issue-1013" class="table-of-contents__link toc-highlight">Issue 1013</a></li><li><a href="#issue-1014" class="table-of-contents__link toc-highlight">Issue 1014</a></li><li><a href="#issue-1015" class="table-of-contents__link toc-highlight">Issue 1015</a></li><li><a href="#issue-1016" class="table-of-contents__link toc-highlight">Issue 1016</a></li><li><a href="#issue-1017" class="table-of-contents__link toc-highlight">Issue 1017</a></li><li><a href="#issue-1018" class="table-of-contents__link toc-highlight">Issue 1018</a></li><li><a href="#issue-1019" class="table-of-contents__link toc-highlight">Issue 1019</a></li><li><a href="#issue-1020" class="table-of-contents__link toc-highlight">Issue 1020</a></li><li><a href="#issue-1021" class="table-of-contents__link toc-highlight">Issue 1021</a></li><li><a href="#issue-1022" class="table-of-contents__link toc-highlight">Issue 1022</a></li><li><a href="#issue-1023" class="table-of-contents__link toc-highlight">Issue 1023</a></li><li><a href="#issue-1024" class="table-of-contents__link toc-highlight">Issue 1024</a></li><li><a href="#issue-1025" class="table-of-contents__link toc-highlight">Issue 1025</a></li><li><a href="#issue-1026" class="table-of-contents__link toc-highlight">Issue 1026</a></li><li><a href="#issue-1027" class="table-of-contents__link toc-highlight">Issue 1027</a></li><li><a href="#issue-1028" class="table-of-contents__link toc-highlight">Issue 1028</a></li><li><a href="#issue-1029" class="table-of-contents__link toc-highlight">Issue 1029</a></li><li><a href="#issue-1030" class="table-of-contents__link toc-highlight">Issue 1030</a></li><li><a href="#issue-1031" class="table-of-contents__link toc-highlight">Issue 1031</a></li><li><a href="#issue-1032" class="table-of-contents__link toc-highlight">Issue 1032</a></li><li><a href="#issue-1033" class="table-of-contents__link toc-highlight">Issue 1033</a></li><li><a href="#issue-1034" class="table-of-contents__link toc-highlight">Issue 1034</a></li><li><a href="#issue-1035" class="table-of-contents__link toc-highlight">Issue 1035</a></li><li><a href="#issue-1036" class="table-of-contents__link toc-highlight">Issue 1036</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">
<div class="footer__applitools">
We use <a href="https://applitools.com/" target="_blank" rel="nofollow"><img src="/img/applitools.png" title="Applitools"></a>
</div>
@@ -74,7 +74,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/miscellaneous/native-filter-migration/index.html b/docs/miscellaneous/native-filter-migration/index.html
index 62eeb31..d6a1b7d 100644
--- a/docs/miscellaneous/native-filter-migration/index.html
+++ b/docs/miscellaneous/native-filter-migration/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -63,7 +63,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/security/cves/index.html b/docs/security/cves/index.html
index 9f6afbd..53772b2 100644
--- a/docs/security/cves/index.html
+++ b/docs/security/cves/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/docs/security/index.html b/docs/security/index.html
index f7a9c90..91adad1 100644
--- a/docs/security/index.html
+++ b/docs/security/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -134,7 +134,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/index.html b/index.html
index 1f5299c..18bee74 100644
--- a/index.html
+++ b/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/markdown-page/index.html b/markdown-page/index.html
index 3cb2324..14ca414 100644
--- a/markdown-page/index.html
+++ b/markdown-page/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
diff --git a/search/index.html b/search/index.html
index 414ffd9..33aa776 100644
--- a/search/index.html
+++ b/search/index.html
@@ -18,7 +18,7 @@
<script src="/script/matomo.js"></script>
<script src="https://www.bugherd.com/sidebarv2.js?apikey=enilpiu7bgexxsnoqfjtxa" async></script><link rel="stylesheet" href="/assets/css/styles.f448a7ff.css">
-<link rel="preload" href="/assets/js/runtime~main.1706d5bb.js" as="script">
+<link rel="preload" href="/assets/js/runtime~main.80273ab1.js" as="script">
<link rel="preload" href="/assets/js/main.ba56a541.js" as="script">
</head>
<body class="navigation-with-keyboard">
@@ -45,7 +45,7 @@
<!-- telemetry/analytics pixel: -->
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=39ae6855-95fc-4566-86e5-360d542b0a68">
</div></div></div></footer></div>
-<script src="/assets/js/runtime~main.1706d5bb.js"></script>
+<script src="/assets/js/runtime~main.80273ab1.js"></script>
<script src="/assets/js/main.ba56a541.js"></script>
</body>
</html>
\ No newline at end of file
