Skip to content

Commit

Permalink
Merge pull request #560 from BalticAmadeus/develop
Browse files Browse the repository at this point in the history
March minor
  • Loading branch information
PauliusKu authored Apr 25, 2024
2 parents 81422d5 + 4992d59 commit 9b8f33a
Show file tree
Hide file tree
Showing 36 changed files with 1,051 additions and 438 deletions.
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"editor.formatOnSave": true,
"editor.tabSize": 4,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
"source.fixAll.eslint": "explicit"
},
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
Expand Down
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# Change Log

## 1.7.0 (2024-04-08)

### Changed

- Reuse existing tabs when opening query grid windows.
- Fixed various small bugs.

### Added

- Favourite tables.

## 1.6.0 (2024-02-07)

### Changed
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ This open source project is in active development. Our goal is to simplify the a
- Launch query
- Launch query on double click
- Select tables form multiple databases
- Favourite tables (_new_)
- Indexes
- Fields
- Filtering
Expand All @@ -37,7 +38,7 @@ This open source project is in active development. Our goal is to simplify the a
- Suggest field names
- View record on double-click
- Enable/disable filtering as you type
- Query grid table size management (_new_)
- Query grid table size management
- Export
- Formats
- .D file
Expand Down
4 changes: 2 additions & 2 deletions docker/.env
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ DB_NAME=sports2020
DB_PORT=30000
DB_MIN_PORT=28020 # Port range must not include ports defined in /etc/services/
DB_MAX_PORT=28050
IMAGE_NAME_126=gitlab.baltic-amadeus.lt:5005/progress/progress-docker/progress-build:12.6.0-centos
IMAGE_NAME_128=gitlab.baltic-amadeus.lt:5005/progress/progress-docker/progress-build:12.8.1-ubuntu

DB_NAME2=sports20201
DB_PORT2=30001
DB_MIN_PORT2=28051 # Port range must not include ports defined in /etc/services/
DB_MAX_PORT2=28080

# Other Configuration Section
PROGRESS_BASE_IMAGE=gitlab.baltic-amadeus.lt:5005/progress/progress-docker/progress-build:12.6.0-centos
PROGRESS_BASE_IMAGE=gitlab.baltic-amadeus.lt:5005/progress/progress-docker/progress-build:12.8.1-ubuntu
8 changes: 4 additions & 4 deletions docker/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
version: '3.7'
services:
sports-db-126:
sports-db-128:
build:
context: "./"
dockerfile: "./Dockerfile"
args:
- IMAGE_NAME=${IMAGE_NAME_126}
- IMAGE_NAME=${IMAGE_NAME_128}
- DB_NAME=${DB_NAME}
environment:
- DB_NAME=${DB_NAME}
Expand All @@ -15,12 +15,12 @@ services:
ports:
- ${DB_PORT}:${DB_PORT}
- ${DB_MIN_PORT}-${DB_MAX_PORT}:${DB_MIN_PORT}-${DB_MAX_PORT}
sports-db-126-2:
sports-db-128-2:
build:
context: "./"
dockerfile: "./Dockerfile"
args:
- IMAGE_NAME=${IMAGE_NAME_126}
- IMAGE_NAME=${IMAGE_NAME_128}
- DB_NAME=${DB_NAME2}
environment:
- DB_NAME=${DB_NAME2}
Expand Down
2 changes: 1 addition & 1 deletion docker/openedge-project.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "pro-bro",
"version": "1.0",
"oeversion": "12.6",
"oeversion": "12.8",
"graphicalMode": false,
"charset": "utf-8",
"extraParameters": "",
Expand Down
47 changes: 46 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"DB",
"Explorer"
],
"version": "1.6.0",
"version": "1.7.0",
"repository": {
"type": "git",
"url": "https://github.com/BalticAmadeus/ProBro"
Expand Down Expand Up @@ -87,6 +87,11 @@
"default": "true",
"markdownDescription": "Use write triggers"
},
"pro-bro.useDeleteTriggers": {
"type": "boolean",
"default": "true",
"markdownDescription": "Use delete triggers"
},
"pro-bro.tempfiles": {
"type": "string",
"markdownDescription": "Specifies path where temporary files are created."
Expand Down Expand Up @@ -177,6 +182,12 @@
"name": "Tables",
"contextualTitle": "Tables",
"title": "Tables"
},
{
"id": "pro-bro-favorites",
"name": "Table favorites",
"contextualTitle": "Table favorites",
"title": "Table favorites"
}
]
},
Expand Down Expand Up @@ -234,6 +245,25 @@
{
"command": "pro-bro.dblClickQuery",
"title": "DblClickQuery"
},
{
"command": "pro-bro.dblClickFavoriteQuery",
"title": "DblClickFavoriteQuery"
},
{
"command": "pro-bro.addFavourite",
"title": "pro-bro: addFavourite",
"icon": "$(star-empty)"
},
{
"command": "pro-bro.removeFavourite",
"title": "pro-bro: removeFavourite",
"icon": "$(star-full)"
},
{
"command": "pro-bro.queryFavorite",
"title": "pro-bro: Query Favorite",
"icon": "$(play)"
}
],
"menus": {
Expand Down Expand Up @@ -289,6 +319,21 @@
"command": "pro-bro.query",
"when": "view == pro-bro-tables",
"group": "inline"
},
{
"command": "pro-bro.addFavourite",
"when": "view == pro-bro-tables",
"group": "inline"
},
{
"command": "pro-bro.removeFavourite",
"when": "view == pro-bro-favorites",
"group": "inline"
},
{
"command": "pro-bro.queryFavorite",
"when": "view == pro-bro-favorites",
"group": "inline"
}
]
}
Expand Down
Binary file modified resources/images/DbConnection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified resources/images/createEditTab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified resources/images/queryWindow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
81 changes: 48 additions & 33 deletions resources/markdown/manual.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,48 @@
# **ProBro user manual**
This document provides guidelines how to use ProBro extension.
# **ProBro user manual**

This document provides guidelines how to use ProBro extension.

## **1. Opening ProBro extension:**

![Db Connection](../images/DbConnection.png)

1. ProBro extension image on sidebar.
2. Create new db connection.
3. Refresh db connection list.
4. Delete existing connection.
5. Edit existing connection.
6. Group lists of databases. If no group is assigned to database, group is set to "Empty".
1. ProBro extension image on sidebar.
2. Create new db connection.
3. Refresh db connection list.
4. Delete existing connection.
5. Edit existing connection.
6. Launch data administration.
7. Launch data dictionary.
8. Launch procedure editor.
9. Refresh single connection.
10. Group lists of databases. If no group is assigned to database, group is set to "Empty".

The icon indicates current status of the connection. Every db connection on the start of the extension or upon refreshing are tested to check if they are connected. Otherwise near the OpenEdge logo a red circle appears which indicates that the connection is unsuccessful (Disabled).

Every db connection on start of extension or refreshing are testes if they are connected. Otherwise near the OpenEdge logo appears red sign.
## **2 Creating new connection**

## **2. Creating new connection**
### **2.1 Importing connections through openedge-project.json**

For creating and editing db connections is used same structure. For editing new tab with selected database information will be displayed.
Connections defined in **_openedge-project.json_** are automatically imported in the extension under seperate connections group. **_dbConnections_** Key must be defined for the connections to be imported.

![Db Create](../images/createEditTab.png)
### **2.2 Creating new connection through the extension**

- **Connection name:** name of your database which will appear in group list.
- **Group:** name of group where database will be assigned. Default group name is "EMPTY"
- **Physical name:** location of you databases .db file.
- **Description:** optional description of db.
- **Host name:** host of database
- Port: port for database
- **User ID** and **password:** optional credentials if needed to connect to database.
- **Other parameters:** optional credentials if needed to connect database.
For creating and editing db connections is used same structure. For editing new tab with selected database information will be displayed.

## **3. Table explorer**
Once selected database, table list is displayed.
![Db Create](../images/createEditTab.png)

- **Connection name:** name of your database which will appear in group list.
- **Group:** name of group where database will be assigned. Default group name is "EMPTY"
- **Physical name:** location of you databases .db file.
- **Description:** optional description of db.
- **Host name:** host of database
- **Port:** port for database
- **User ID** and **password:** optional credentials if needed to connect to database.
- **Other parameters:** optional credentials if needed to connect database.

## **3. Table explorer**

Once the database is selected, table list is displayed. When clicked on the table list view, press CTRL + F for the ability to search for a certain table.

![table Explorer](../images/tableExplorer.png)

Expand All @@ -40,16 +52,17 @@ This document provides guidelines how to use ProBro extension.

## 4. Fields and Indexes explorer

- Select table to see fields and indexes. Fields and Indexes are displayed in panel view. By default, they are on separate tabs, but can be merged by dragging.
- Select table to see fields and indexes. Fields and Indexes are displayed in the panel view. By default, they are on separate tabs, but can be merged by dragging.

<img src="../images/mergeFieldsIndexes.gif" height="150">

- In fields explorer has multi-sorting and multi-filtering options.
Multi-sorting can be used by holding CTRL key and selecting preferred columns.
- Fields explorer has multi-sorting and multi-filtering options.
Multi-sorting can be used by holding CTRL key and selecting preferred columns.

<img src="../images/multisorting.gif">

- By selecting field rows, query columns can be shown/hidden.
- By selecting field rows, query columns can be shown/hidden.
- RECID, ROWID fields are hidden by default. They can be enabled through the fields explorer.

## **5. Query window**

Expand All @@ -58,24 +71,26 @@ In first launch of query, all records are displayed.
ProBro extension uses server-side multi-sorting and multi-filtering.

![query window](../images/queryWindow.png)

1. **Custom query** request can be written to filter records. Query should be formatted like WHERE statement.
2. **Export of records:**
- formats available for exporting:
- JSON;
- Excel;
- formats available for exporting:
- JSON.
- Excel.
- CSV.
- dumpFile.
- The scope for exporting records can be selected:
- table: export all records. ;
- Filter: export only filtered records;
- Selection: export only selected rows of records.
- When selected table or filter scopes, custom queried data will be exported.
- Record are exported in user sorted order.
3. **Record display formats:**
- RAW - Json formatted data;
- <s>RAW</s> - OE formatted data.
3. **Format:**
- JSON - JSON formatted data;
- PROGRESS - OE formatted data.
4. **CRUD operations:**
- CREATE - create record;
- UPDATE - update record. Available only when there is one selected record.
- DELETE - deletes one or more selected records.
- READ - double clicked on record, all details are shown in popup box.
5. **Data retrieval information:** ProBro extension is using lazy loading for better performance with large tables. Information shows current number of records, recent number of records loaded and record retrieval time in ms.
5. **Data retrieval information:** ProBro extension is using lazy loading for better performance with large tables. Information shows current number of records, recent number of records loaded and record retrieval time in ms.
2 changes: 1 addition & 1 deletion resources/oe/src/oe.p
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ FIELD cKey AS CHARACTER SERIALIZE-NAME "key"
FIELD cLabel AS CHARACTER SERIALIZE-NAME "label"
FIELD cType AS CHARACTER SERIALIZE-NAME "type"
FIELD cFormat AS CHARACTER SERIALIZE-NAME "format"
FIELD iExtent AS INTEGER
FIELD iExtent AS INTEGER
.

message PROPATH.
Expand Down
Loading

0 comments on commit 9b8f33a

Please sign in to comment.