fabio286
/
antares
mirror of https://github.com/Fabio286/antares.git
1
1
Fork 0
Code Issues Releases Wiki Activity

feat(PostgreSQL): ability to switch the database, closes #432

This commit is contained in:
Fabio Di Stasio 2023-06-13 18:10:52 +02:00
parent 9d00f58998
commit 89815bf5e7
15 changed files with 15113 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14939
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

14
src/main/ipc-handlers/database.ts Normal file
View File

@ -0,0 +1,14 @@
import * as antares from 'common/interfaces/antares';
import { ipcMain } from 'electron';
export default (connections: {[key: string]: antares.Client}) => {
ipcMain.handle('get-databases', async (event, uid) => {
try {
const result = await connections[uid].getDatabases();
return { status: 'success', response: result };
}
catch (err) {
return { status: 'error', response: err.toString() };
}
});
};

2
src/main/ipc-handlers/index.ts
View File

@ -9,6 +9,7 @@ import functions from './functions';
import schedulers from './schedulers';
import updates from './updates';
import application from './application';
import database from './database';
import schema from './schema';
import users from './users';
@ -22,6 +23,7 @@ export default () => {
routines(connections);
functions(connections);
schedulers(connections);
database(connections);
schema(connections);
users(connections);
updates();

4
src/main/libs/AntaresCore.ts
View File

@ -162,6 +162,10 @@ export abstract class AntaresCore {
throw new Error('Method "getDbConfig" not implemented');
}
getDatabases () {
throw new Error('Method "getDatabases" not implemented');
}
createSchema (...args: any) {
throw new Error('Method "createSchema" not implemented');
}

14
src/main/libs/clients/PostgreSQLClient.ts
View File

@ -154,7 +154,7 @@ export class PostgreSQLClient extends AntaresCore {
host: this._params.host,
port: this._params.port,
user: this._params.user,
database: undefined as string | undefined,
database: 'postgres' as string,
password: this._params.password,
ssl: null as mysql.SslOptions
};
@ -262,6 +262,18 @@ export class PostgreSQLClient extends AntaresCore {
return [];
}
async getDatabases () {
const { rows } = await this.raw('SELECT datname FROM pg_database WHERE datistemplate = false');
if (rows) {
return rows.reduce((acc, cur) => {
acc.push(cur.datname);
return acc;
}, [] as string[]);
}
else
return [];
}
async getStructure (schemas: Set<string>) {
/* eslint-disable camelcase */
interface ShowTableResult {

4
src/main/main.ts
View File

@ -124,8 +124,8 @@ else {
if (isWindows)
mainWindow.show();
if (isDevelopment)
mainWindow.webContents.openDevTools();
// if (isDevelopment)
// mainWindow.webContents.openDevTools();
process.on('uncaughtException', error => {
mainWindow.webContents.send('unhandled-exception', error);

4
src/renderer/components/SettingBarConnectionsFolder.vue
View File

@ -380,7 +380,7 @@ emit('folder-sort');// To apply changes on component key change
overflow: hidden;
white-space: nowrap;
text-overflow: ellipsis;
line-height: 1;
line-height: 1.02;
transition: bottom .2s;
}
}
@ -444,7 +444,7 @@ emit('folder-sort');// To apply changes on component key change
overflow: hidden;
white-space: nowrap;
text-overflow: ellipsis;
line-height: 1;
line-height: 1.02;
}
}
}

4
src/renderer/components/Workspace.vue
View File

@ -565,6 +565,10 @@ const workspace = computed(() => getWorkspace(props.connection.uid));
const draggableTabs = computed<WorkspaceTab[]>({
get () {
if (workspace.value.customizations.database)
return workspace.value.tabs.filter(tab => tab.type === 'query' || tab.database === workspace.value.database);
else
return workspace.value.tabs;
},
set (val) {

1
src/renderer/components/WorkspaceAddConnectionPanel.vue
View File

@ -120,6 +120,7 @@
v-model="connection.database"
class="form-input"
type="text"
:placeholder="clientCustomizations.defaultDatabase"
>
</div>
</div>

1
src/renderer/components/WorkspaceEditConnectionPanel.vue
View File

@ -122,6 +122,7 @@
v-model="localConnection.database"
class="form-input"
type="text"
:placeholder="clientCustomizations.defaultDatabase"
>
</div>
</div>

78
src/renderer/components/WorkspaceExploreBar.vue
View File

@ -10,7 +10,18 @@
@keydown="explorebarSearch"
>
<div class="workspace-explorebar-header">
<span class="workspace-explorebar-title">{{ connectionName }}</span>
<div
v-if="customizations.database"
class="workspace-explorebar-database-switch"
:title="t('message.switchDatabase')"
>
<BaseSelect
v-model="selectedDatabase"
:options="databases"
class="form-select select-sm text-bold my-0"
/>
</div>
<span v-else class="workspace-explorebar-title">{{ connectionName }}</span>
<span v-if="workspace.connectionStatus === 'connected'" class="workspace-explorebar-tools">
<i
v-if="customizations.schemas"
@ -124,10 +135,11 @@
</template>
<script setup lang="ts">
import { Component, computed, onMounted, Ref, ref, watch } from 'vue';
import { Component, computed, onMounted, Prop, Ref, ref, watch } from 'vue';
import { storeToRefs } from 'pinia';
import { useConnectionsStore } from '@/stores/connections';
import { ConnectionParams } from 'common/interfaces/antares';
import { useNotificationsStore } from '@/stores/notifications';
import { useSettingsStore } from '@/stores/settings';
import { useWorkspacesStore } from '@/stores/workspaces';
@ -141,12 +153,14 @@ import TableContext from '@/components/WorkspaceExploreBarTableContext.vue';
import MiscContext from '@/components/WorkspaceExploreBarMiscContext.vue';
import MiscFolderContext from '@/components/WorkspaceExploreBarMiscFolderContext.vue';
import ModalNewSchema from '@/components/ModalNewSchema.vue';
import BaseSelect from '@/components/BaseSelect.vue';
import { useI18n } from 'vue-i18n';
import Databases from '@/ipc-api/Databases';
const { t } = useI18n();
const props = defineProps({
connection: Object,
connection: Object as Prop<ConnectionParams>,
isSelected: Boolean
});
@ -160,11 +174,13 @@ const { explorebarSize } = storeToRefs(settingsStore);
const { changeExplorebarSize } = settingsStore;
const {
getWorkspace,
switchConnection,
removeConnected: disconnectWorkspace,
refreshStructure,
newTab,
removeTabs,
setSearchTerm,
setDatabase,
addLoadingElement,
removeLoadingElement
} = workspacesStore;
@ -172,6 +188,7 @@ const {
const searchInput: Ref<HTMLInputElement> = ref(null);
const explorebar: Ref<HTMLInputElement> = ref(null);
const resizer: Ref<HTMLInputElement> = ref(null);
const databases: Ref<string[]> = ref([]);
const schema: Ref<Component & { selectSchema: (name: string) => void; $refs: {schemaAccordion: HTMLDetailsElement} }[]> = ref(null);
const isRefreshing = ref(false);
const isNewDBModal = ref(false);
@ -185,6 +202,7 @@ const isMiscFolderContext = ref(false);
const databaseContextEvent = ref(null);
const tableContextEvent = ref(null);
const miscContextEvent = ref(null);
const selectedDatabase = ref(props.connection.database);
const selectedSchema = ref('');
const selectedTable = ref(null);
const selectedMisc = ref(null);
@ -230,9 +248,14 @@ watch(searchTerm, () => {
}, 200);
});
watch(selectedDatabase, (val, oldVal) => {
if (oldVal)
switchConnection({ ...props.connection, database: selectedDatabase.value });
});
localWidth.value = explorebarSize.value;
onMounted(() => {
onMounted(async () => {
resizer.value.addEventListener('mousedown', (e: MouseEvent) => {
e.preventDefault();
@ -240,10 +263,28 @@ onMounted(() => {
window.addEventListener('mouseup', stopResize);
});
if (workspace.value.structure.length === 1) { // Auto-open if juust one schema
if (workspace.value.structure.length === 1) { // Auto-open if just one schema
schema.value[0].selectSchema(workspace.value.structure[0].name);
schema.value[0].$refs.schemaAccordion.open = true;
}
if (customizations.value.database) {
try {
const { status, response } = await Databases.getDatabases(props.connection.uid);
if (status === 'success') {
databases.value = response;
if (selectedDatabase.value === '') {
selectedDatabase.value = response[0];
setDatabase(selectedDatabase.value);
}
}
else
addNotification({ status: 'error', message: response });
}
catch (err) {
addNotification({ status: 'error', message: err.stack });
}
}
});
const refresh = async () => {
@ -254,7 +295,10 @@ const refresh = async () => {
}
};
const explorebarSearch = () => {
const explorebarSearch = (event: KeyboardEvent) => {
const isLetter = (event.key >= 'a' && event.key <= 'z');
const isNumber = (event.key >= '0' && event.key <= '9');
if (isLetter || isNumber)
searchInput.value.focus();
};
@ -497,13 +541,31 @@ const toggleSearchMethod = () => {
}
}
.workspace-explorebar-database-switch {
width: 100%;
display: flex;
justify-content: space-between;
z-index: 20;
margin-right: 5px;
margin-left: -4px;
margin-top: -3px;
margin-bottom: -0.5rem;
height: 24px;
.form-select.select-sm {
font-size: 0.6rem;
height: 1.2rem;
line-height: 1rem;
}
}
.workspace-explorebar-search {
width: 100%;
display: flex;
justify-content: space-between;
font-size: 0.6rem;
height: 28px;
margin: 5px 0;
margin: 0 0 5px 0;
z-index: 10;
.has-icon-right {
@ -533,7 +595,7 @@ const toggleSearchMethod = () => {
.workspace-explorebar-body {
width: 100%;
height: calc((100vh - 68px) - #{$excluding-size});
height: calc((100vh - 63px) - #{$excluding-size});
overflow: overlay;
padding: 0 0.1rem;
}

8
src/renderer/components/WorkspaceTabQuery.vue
View File

@ -291,6 +291,11 @@ watch(selectedSchema, () => {
changeBreadcrumbs({ schema: selectedSchema.value, query: `Query #${props.tab.index}` });
});
watch(databaseSchemas, () => {
if (!databaseSchemas.value.includes(selectedSchema.value))
selectedSchema.value = null;
}, { deep: true });
const runQuery = async (query: string) => {
if (!query || isQuering.value) return;
isQuering.value = true;
@ -496,9 +501,6 @@ defineExpose({ resizeResults });
query.value = props.tab.content as string;
selectedSchema.value = props.tab.schema || breadcrumbsSchema.value;
if (!databaseSchemas.value.includes(selectedSchema.value))
selectedSchema.value = null;
window.addEventListener('resize', onWindowResize);
const reloadListener = () => {

3
src/renderer/i18n/en-US.ts
View File

@ -348,7 +348,8 @@ export const enUS = {
closeAllTabs: 'Close all tabs',
closeOtherTabs: 'Close other tabs',
closeTabsToLeft: 'Close tabs to the left',
closeTabsToRight: 'Close tabs to the right'
closeTabsToRight: 'Close tabs to the right',
switchDatabase: 'Switch the database'
},
faker: {
address: 'Address',

9
src/renderer/ipc-api/Databases.ts Normal file
View File

@ -0,0 +1,9 @@
import { ipcRenderer } from 'electron';
import { unproxify } from '../libs/unproxify';
import { IpcResponse } from 'common/interfaces/antares';
export default class {
static getDatabases (params: string): Promise<IpcResponse> {
return ipcRenderer.invoke('get-databases', unproxify(params));
}
}

55
src/renderer/stores/workspaces.ts
View File

@ -30,6 +30,7 @@ export interface WorkspaceTab {
index?: number;
selected?: boolean;
type?: string;
database?: string;
schema?: string;
elementName?: string;
elementNewName?: string;
@ -65,6 +66,7 @@ export interface Breadcrumb {
export interface Workspace {
uid: string;
client?: ClientCode;
database?: string;
connectionStatus: string;
selectedTab: string | number;
searchTerm: string;
@ -145,14 +147,15 @@ export const useWorkspacesStore = defineStore('workspaces', {
else
this.selectedWorkspace = uid;
},
async connectWorkspace (connection: ConnectionParams & { pgConnString?: string }) {
async connectWorkspace (connection: ConnectionParams & { pgConnString?: string }, mode?: string) {
this.workspaces = (this.workspaces as Workspace[]).map(workspace => workspace.uid === connection.uid
? {
...workspace,
structure: {},
structure: [],
breadcrumbs: {},
loadedSchemas: new Set(),
connectionStatus: 'connecting'
database: connection.database,
connectionStatus: mode === 'switch' ? 'connected' : 'connecting'
}
: workspace);
@ -168,7 +171,7 @@ export const useWorkspacesStore = defineStore('workspaces', {
this.workspaces = (this.workspaces as Workspace[]).map(workspace => workspace.uid === connection.uid
? {
...workspace,
structure: {},
structure: [],
breadcrumbs: {},
loadedSchemas: new Set(),
connectionStatus: 'failed'
@ -228,6 +231,12 @@ export const useWorkspacesStore = defineStore('workspaces', {
}, null);
}
const selectedTab = cachedTabs.length
? connection.database
? cachedTabs.filter(tab => tab.type === 'query' || tab.database === connection.database)[0].uid
: cachedTabs[0].uid
: null;
this.workspaces = (this.workspaces as Workspace[]).map(workspace => workspace.uid === connection.uid
? {
...workspace,
@ -238,7 +247,7 @@ export const useWorkspacesStore = defineStore('workspaces', {
structure: response,
connectionStatus: 'connected',
tabs: cachedTabs,
selectedTab: cachedTabs.length ? cachedTabs[0].uid : null,
selectedTab,
version
}
: workspace);
@ -385,7 +394,7 @@ export const useWorkspacesStore = defineStore('workspaces', {
this.workspaces = (this.workspaces as Workspace[]).map(workspace => workspace.uid === uid
? {
...workspace,
structure: {},
structure: [],
breadcrumbs: {},
loadedSchemas: new Set(),
connectionStatus: 'disconnected'
@ -394,6 +403,10 @@ export const useWorkspacesStore = defineStore('workspaces', {
this.selectTab({ uid, tab: 0 });
},
async switchConnection (connection: ConnectionParams & { pgConnString?: string }) {
await Connection.disconnect(connection.uid);
return this.connectWorkspace(connection, 'switch');
},
addWorkspace (uid: string) {
const workspace: Workspace = {
uid,
@ -468,7 +481,15 @@ export const useWorkspacesStore = defineStore('workspaces', {
}
: workspace);
},
_addTab ({ uid, tab, content, type, autorun, schema, elementName, elementType }: WorkspaceTab) {
setDatabase (databaseName: string) {
this.workspaces = (this.workspaces as Workspace[]).map(workspace => workspace.uid === this.getSelected
? {
...workspace,
database: databaseName
}
: workspace);
},
_addTab ({ uid, tab, content, type, autorun, schema, database, elementName, elementType }: WorkspaceTab) {
if (type === 'query')
tabIndex[uid] = tabIndex[uid] ? ++tabIndex[uid] : 1;
@ -477,6 +498,7 @@ export const useWorkspacesStore = defineStore('workspaces', {
index: type === 'query' ? tabIndex[uid] : null,
selected: false,
type,
database,
schema,
elementName,
elementType,
@ -534,6 +556,7 @@ export const useWorkspacesStore = defineStore('workspaces', {
content,
type,
autorun,
database: workspaceTabs.database,
schema,
elementName,
elementType
@ -572,7 +595,7 @@ export const useWorkspacesStore = defineStore('workspaces', {
});
tabUid = uidGen('T');
this._addTab({ uid, tab: tabUid, content, type, autorun, schema, elementName, elementType });
this._addTab({ uid, tab: tabUid, content, type, autorun, database: workspaceTabs.database, schema, elementName, elementType });
}
else {
this._replaceTab({ uid, tab: tab.uid, type, schema, elementName, elementType });
@ -582,7 +605,7 @@ export const useWorkspacesStore = defineStore('workspaces', {
}
else {
tabUid = uidGen('T');
this._addTab({ uid, tab: tabUid, content, type, autorun, schema, elementName, elementType });
this._addTab({ uid, tab: tabUid, content, type, autorun, database: workspaceTabs.database, schema, elementName, elementType });
}
}
}
@ -603,18 +626,18 @@ export const useWorkspacesStore = defineStore('workspaces', {
: false;
if (existentTab) {
this._replaceTab({ uid, tab: existentTab.uid, type, schema, elementName, elementType });
this._replaceTab({ uid, tab: existentTab.uid, type, database: workspaceTabs.database, schema, elementName, elementType });
tabUid = existentTab.uid;
}
else {
tabUid = uidGen('T');
this._addTab({ uid, tab: tabUid, content, type, autorun, schema, elementName, elementType });
this._addTab({ uid, tab: tabUid, content, type, autorun, database: workspaceTabs.database, schema, elementName, elementType });
}
}
break;
default:
tabUid = uidGen('T');
this._addTab({ uid, tab: tabUid, content, type, autorun, schema, elementName, elementType });
this._addTab({ uid, tab: tabUid, content, type, autorun, database: workspaceTabs.database, schema, elementName, elementType });
break;
}
@ -626,8 +649,14 @@ export const useWorkspacesStore = defineStore('workspaces', {
? workspace.tabs.some(tab => tab.uid === workspace.selectedTab)
: false;
if (!isSelectedExistent && workspace.tabs.length)
if (!isSelectedExistent && workspace.tabs.length) {
if (workspace.customizations.database) {
const databaseTabs = workspace.tabs.filter(tab => tab.type === 'query' || tab.database === workspace.database);
this.selectTab({ uid, tab: databaseTabs[databaseTabs.length - 1].uid });
}
else
this.selectTab({ uid, tab: workspace.tabs[workspace.tabs.length - 1].uid });
}
},
updateTabContent ({ uid, tab, type, schema, content }: WorkspaceTab) {
this._replaceTab({ uid, tab, type, schema, content });