superset-frontend/src/hooks/apiResources/sqlLab.ts
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import type { QueryResponse } from '@superset-ui/core';
import type { JsonResponse } from './queryApi';
import { api } from './queryApi';
export type InitialState = {
active_tab: {
id: number;
user_id: number;
label: string;
active: boolean;
database_id: number;
catalog?: string | null;
schema?: string;
table_schemas: {
id: number;
table: string;
description: {
columns?: {
name: string;
type: string;
}[];
dataPreviewQueryId?: string;
} & Record<string, any>;
catalog?: string | null;
schema?: string;
tab_state_id: number;
database_id?: number;
expanded?: boolean;
}[];
sql: string;
query_limit?: number;
latest_query: QueryResponse | null;
autorun?: boolean;
template_params: string | null;
hide_left_bar?: boolean;
saved_query: { id: number } | null;
extra_json?: Record<string, any>;
};
databases: object[];
queries: Record<
string,
Omit<QueryResponse, 'startDttm' | 'endDttm'> & {
startDttm: number | string;
endDttm: number | string;
inLocalStorage?: boolean;
}
>;
tab_state_ids: {
id: number;
label: string;
}[];
};
const initialStateApi = api.injectEndpoints({
endpoints: builder => ({
sqlLabInitialState: builder.query<InitialState, void>({
providesTags: ['SqlLabInitialState'],
query: () => ({
endpoint: `/api/v1/sqllab/`,
headers: { 'Content-Type': 'application/json' },
transformResponse: ({ json }: JsonResponse) => json.result,
}),
}),
}),
});
export const { useSqlLabInitialStateQuery: useSqlLabInitialState } =
initialStateApi;