Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Corrected Generation Of Entity Relationship Diagram #153

Merged
merged 10 commits into from
Aug 11, 2024
Merged

Corrected Generation Of Entity Relationship Diagram #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
a0e1140
Corrected inverted relationships
tslever Aug 9, 2024
e4ece3d
Generated correct Entity Relationship Diagram
tslever Aug 9, 2024
3e9a724
Used Linux to generate vsix file / extension to generate ERDs
tslever Aug 9, 2024
6b318fd
Used includes instead of indexOf and improved docs
tslever Aug 9, 2024
0dd84c7
Possibly corrected inverted cardinality per https://mermaid.js.org/sy…
tslever Aug 9, 2024
51d0f4a
Removed backend/yarn.lock to allow CI
tslever Aug 9, 2024
24241f3
Updated TypeScript and VSCode types
tslever Aug 9, 2024
c249f15
Revised tests of relationships
tslever Aug 9, 2024
62acb08
Deleted files named package-lock.json
tslever Aug 10, 2024
638f483
Update docs.md
tslever Aug 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions backend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,17 @@
"test": "jest --config=jest.config.js"
},
"devDependencies": {
"@types/azdata": "1.33.0",
"@types/jest": "^26.0.20",
"@types/node": "^13.9.3",
"@types/vscode": "^1.63.0",
"@types/azdata": "1.33.0",
"@types/vscode": "^1.92.0",
"azdata-test": "^1.2.0",
"jest": "^26.6.3",
"ts-jest": "^26.5.4",
"tslint": "^6.1.0",
"typescript": "^3.8.3",
"typescript": "^5.5.4",
"vsce": "^1.71.0",
"vscode-test": "^1.6.1",
"azdata-test": "^1.2.0"
"vscode-test": "^1.6.1"
},
"dependencies": {
"svg-to-pdfkit": "^0.1.8"
Expand Down
6 changes: 3 additions & 3 deletions backend/src/services/builder.service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,11 @@ describe("chartBuilder", () => {
});

[
{ kind: "one to many", md: "||--|{", replaceColumn: {} },
{ kind: "zero to many", md: "|o--|{", replaceColumn: { nullable: true } },
{ kind: "one to many", md: "}|--||", replaceColumn: {} },
{ kind: "zero to many", md: "|}--o|", replaceColumn: { nullable: true } },
{
kind: "one to one",
md: "||--||",
md: "||--|{",
replaceColumn: { constraints: ["PRIMARY KEY", "FOREIGN KEY", "UNIQUE"] },
},
].forEach((element) => {
Expand Down
14 changes: 10 additions & 4 deletions backend/src/services/builder.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,21 @@ export const chartBuilder = (tables: DatabaseTable[]) => {
};

const getRelation = (column: DatabaseColumn) => {
const constraints = column.constraints;

if (column.nullable && constraints.includes("UNIQUE")) {
return "|o--||";
}

if (column.nullable) {
return "|o--|{";
return "|}--o|";
}

if (column.constraints.includes("UNIQUE")) {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

includes has better readability

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@R0tenur , I used includes instead of indexOf after getting everything working.

return "||--||";
if (constraints.includes("UNIQUE")) {
return "||--|{";
}

return "||--|{";
return "}|--||";
};

const formatConstraints = (element?: string[]) =>
Expand Down
5,044 changes: 0 additions & 5,044 deletions backend/yarn.lock
View file
Open in desktop

This file was deleted.

115 changes: 78 additions & 37 deletions docs/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# Schema Visualization
# Generating vsix File / Extension For Azure Data Studio

This page is for developers that want to run the project locally.
This page is for developers that want to use a local version of this repository to create a vsix file that can be installed as an extension in Azure Data Studio and used to create Entity Relationship Diagrams.

## Prerequisites
- A recent version of node.js
- yarn or npm
## Notes

- You might consider generating a vsix file on an operating system like Ubuntu 22.04.3 LTS (GNU/Linux 5.15.153.1-microsoft-standard-WSL2 x86_64) or Windows 11 Home, Version 22H2, OS build 22621.3880, Windows Feature Experience Pack 1000.22700.1020.0.

## Prerequisites For Generating vsix File

- A recent version of node.js. You might consider installing `nvm` and Node.js version 20.16.0 per [How To Set Up NVM](https://github.com/tslever/React/blob/main/How_To_Set_Up_NVM.md).
- yarn, or npm and yarn. You might consider installing yarn by running `npm install --global yarn`.

To be able to use a debugger:
- vscode - for the development
- [Azure Data Studio Debug](https://marketplace.visualstudio.com/items?itemName=ms-mssql.sqlops-debug) extension

## Installation
In a terminal:
## Installing This Node.js Project

### Yarn:
### yarn

Backend
```sh
Expand All @@ -25,49 +29,86 @@ Frontend
cd frontend && yarn
```

### Npm
### npm

Ensure you are using your installed version of Node.js (e.g., 20.16.0) by running `node --version`.

Navigate to the root of this repository.

Run `cd backend`.

Run `npm i`.

Run `mkdir out`.

Run `cd ../frontend`.

Run `npm i`.

## Compile

### yarn

Backend
```sh
cd backend && npm i && mkdir out
cd frontend && yarn run build && cd ../backend && yarn run compile
```

Frontend
### npm

Run `cd ../frontend`.

Run `npm run build`.

Run `cd ../backend`.

Run `npm run compile`.

## Pack

### yarn

```sh
cd frontend && npm i
cd backend && yarn run
```

## Compile and pack
### Yarn
Compile:
```sh
cd frontend && yarn run build && cd ../backend && yarn run compile
```
Pack:
```sh
cd backend && yarn run
```

### Npm
Compile:
```sh
cd frontend && npm run build && cd ../backend && npm run compile
```
Pack:
```sh
cd backend && npm run pack
```


This will generate an vsix that can be installed in azure data studio.
### npm

Run `cd ../backend`.

Run `npm run pack`.

Move `<ROOT OF THIS REPOSITORY>/backend/schema-visualization-<MAJOR VERSION NUMBER>.<MINOR VERSION NUMBER>.<PATCH NUMBER>.vsix` to a desired location for installation as an extension in Azure Data Studio.

## Install vsix File In Azure Data Studio

Install Azure Data Studio (e.g., Azure Data Studio for User version 1.49.0).

Open Azure Data Studio.

Open Extensions.

Click the ellipsis and Install from VSIX...

Install the above vsix file.

On the Welcome screen click "Create a connection".

Connect to a database server.

Right click the database server and click Manage.

Click Schema Visualization.

## Debug

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why removing info about debugging and frontend dev?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@R0tenur , I restored info about debugging and using your front end.

By using vscode as editor with the extension [Azure Data Studio Debug](https://marketplace.visualstudio.com/items?itemName=ms-mssql.sqlops-debug) you are able to set breakpoints in the backend code. Start in debug mode by pressing f5.

## Frontend

The frontend is based on Angular and can be runned without the backend in the browser by:

```sh
cd frontend && yarn start
```
Then it's possible to run a mocked environment in the browser at `localhost:4200`

Then it's possible to run a mocked environment in the browser at `localhost:4200`
34 changes: 17 additions & 17 deletions frontend/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@
},
"private": true,
"dependencies": {
"@angular/animations": "^16.2.1",
"@angular/common": "^16.2.1",
"@angular/compiler": "^16.2.1",
"@angular/core": "^16.2.1",
"@angular/forms": "^16.2.1",
"@angular/platform-browser": "^16.2.1",
"@angular/platform-browser-dynamic": "^16.2.1",
"@angular/router": "^16.2.1",
"@angular/animations": "^16.2.12",
"@angular/common": "^16.2.12",
"@angular/compiler": "^16.2.12",
"@angular/core": "^16.2.12",
"@angular/forms": "^16.2.12",
"@angular/platform-browser": "^16.2.12",
"@angular/platform-browser-dynamic": "^16.2.12",
"@angular/router": "^16.2.12",
"d3": "^7.8.5",
"mermaid": "^9.1.2",
"ng": "^0.0.0",
Expand All @@ -29,22 +29,22 @@
"zone.js": "~0.13.1"
},
"devDependencies": {
"@angular-devkit/build-angular": "^16.2.0",
"@angular-eslint/builder": "16.1.0",
"@angular-eslint/eslint-plugin": "16.1.0",
"@angular-eslint/eslint-plugin-template": "16.1.0",
"@angular-eslint/schematics": "16.1.0",
"@angular-eslint/template-parser": "16.1.0",
"@angular/cli": "^16.2.0",
"@angular/compiler-cli": "^16.2.1",
"@angular-devkit/build-angular": "^16.2.12",
"@angular-eslint/builder": "^16.2.12",
"@angular-eslint/eslint-plugin": "^16.2.12",
"@angular-eslint/eslint-plugin-template": "^16.2.12",
"@angular-eslint/schematics": "^16.2.12",
"@angular-eslint/template-parser": "^16.2.12",
"@angular/cli": "^16.2.12",
"@angular/compiler-cli": "^16.2.12",
"@types/d3": "^7.4.0",
"@types/jasmine": "~3.6.0",
"@types/node": "^12.11.1",
"@typescript-eslint/eslint-plugin": "^5.59.2",
"@typescript-eslint/parser": "^5.59.2",
"eslint": "^8.39.0",
"html-inline": "^1.2.0",
"jasmine-core": "~3.6.0",
"jasmine-core": "^3.8.0",
"jasmine-spec-reporter": "~5.0.0",
"karma": "~6.3.16",
"karma-chrome-launcher": "~3.1.0",
Expand Down
Loading
Loading