Skip to content

Commit 4c27634

Browse files
committed
readme and more images
1 parent b8a3529 commit 4c27634

9 files changed

Lines changed: 59 additions & 2 deletions

File tree

.vscode/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
"ns": "BLOCKS",
55
"docker-compose": {
66
"service": "server"
7+
},
8+
"links": {
9+
"BlocksExplorer": "http://localhost/"
710
}
811
}
912
}

README.md

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,5 +64,59 @@ By default running on 80 port. To start using it, just open http://localhost/
6464

6565
## Screenshots
6666

67-
![Tree](https://cloud.githubusercontent.com/assets/1212251/9978584/f4964ada-5f40-11e5-8b23-2d20cb03e7b1.png)
68-
![Map](https://cloud.githubusercontent.com/assets/1212251/9978586/f967a3e2-5f40-11e5-82a4-8588d47340b5.png)
67+
![Tree](https://raw.githubusercontent.com/daimor/BlocksExplorer/master/images/TreeView.png)
68+
![Map](https://raw.githubusercontent.com/daimor/BlocksExplorer/master/images/MapView.png)
69+
70+
## CLI mode
71+
72+
Using prebuild docker image gives a way to generate a picture for any IRIS or Caché database.
73+
Use docker image `daimor/blocksexplorer:iris` for IRIS or `daimor/blocksexplorer:cache` for Caché Databases.
74+
Those images accepts command `generate` with arguments
75+
76+
* path to the tested databases inside a container, by default `/db`, can be omited
77+
* cellSize - size of the cell in pixels, where each cell represents particular database's block, by default 1
78+
* cellSpace - sorrounding space between cell, by default 0
79+
* showFill - sign to show how much block fill by data, by default 0
80+
81+
This tool generates a square picture in folder /out inside a container in formats BMP and PNG.
82+
83+
So, with command like this
84+
```
85+
docker run -v `pwd`/out:/out daimor/blocksexplorer:iris generate 20 1 1
86+
```
87+
It will generate this picture for an empty database.
88+
89+
![TESTDB](https://raw.githubusercontent.com/daimor/BlocksExplorer/master/images/TESTDB_20_1_1.png)
90+
With a lighter color visible that most of the blocks just empty.
91+
92+
The same test empty database, but with showFill=0
93+
```
94+
docker run -v `pwd`/out:/out daimor/blocksexplorer:iris generate 20 1 0
95+
```
96+
Blocks have different colors but just for globals, and does not show how much it fill.
97+
98+
![TESTDB](https://raw.githubusercontent.com/daimor/BlocksExplorer/master/images/TESTDB_20_1_0.png)
99+
100+
More examples
101+
ENSLIB
102+
```
103+
docker run -v `pwd`/out:/out daimor/blocksexplorer:iris generate /usr/irissys/mgr/enslib 5 1
104+
```
105+
![ENSLIB](https://raw.githubusercontent.com/daimor/BlocksExplorer/master/images/ENSLIB_5_1_0.png)
106+
107+
IRISSYS
108+
```
109+
docker run -v `pwd`/out:/out daimor/blocksexplorer:iris generate /usr/irissys/mgr/ 5 1 1
110+
```
111+
![IRISSYS](https://raw.githubusercontent.com/daimor/BlocksExplorer/master/images/IRISSYS_5_1_1.png)
112+
113+
114+
For large databases, would not recommend to use have too big cellSize.
115+
116+
### Useful Links
117+
118+
There you can find more about database internals, and how to use this tool.
119+
* [Internal Structure of Caché Database Blocks, Part 1](https://community.intersystems.com/post/internal-structure-cach%C3%A9-database-blocks-part-1)
120+
* [Internal Structure of Caché Database Blocks, Part 2](https://community.intersystems.com/post/internal-structure-cach%C3%A9-database-blocks-part-2)
121+
* [Internal Structure of Caché Database Blocks, Part 3](https://community.intersystems.com/post/internal-structure-cach%C3%A9-database-blocks-part-3)
122+

images/ENSLIB_5_1_0.png

4.82 KB
Loading

images/IRISSYS_5_1_0.png

3.4 KB
Loading

images/IRISSYS_5_1_1.png

4.84 KB
Loading

images/MapView.png

1.14 MB
Loading

images/TESTDB_20_1_0.png

1.08 KB
Loading

images/TESTDB_20_1_1.png

1.14 KB
Loading

images/TreeView.png

1.08 MB
Loading

0 commit comments

Comments
 (0)