mirror of
https://github.com/alm494/sql_proxy.git
synced 2026-04-05 11:51:03 +02:00
added docs and some uml
This commit is contained in:
Almaz Sharipov
@@ -19,7 +19,7 @@ A lightweight REST service designed to replace ADODB calls in legacy software sy
|
||||
|
||||
## API description
|
||||
|
||||
See Swagger OpenAPI 3.0 specification in /src/docs
|
||||
See Swagger OpenAPI 3.0 specification in /src/docs/api
|
||||
|
||||
## How to compile
|
||||
|
||||
|
||||
88
src/docs/dblist.drawio
Normal file
88
src/docs/dblist.drawio
Normal file
@@ -0,0 +1,88 @@
|
||||
<mxfile host="65bd71144e">
|
||||
<diagram id="feCwla5sKzhYdv7hU_Ah" name="Page-1">
|
||||
<mxGraphModel dx="806" dy="571" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
|
||||
<root>
|
||||
<mxCell id="0"/>
|
||||
<mxCell id="1" parent="0"/>
|
||||
<mxCell id="2" value="DbList" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
|
||||
<mxGeometry x="10" y="40" width="350" height="299.28" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="3" value="+ items: SynMap" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="2" vertex="1">
|
||||
<mxGeometry y="26" width="350" height="25.28" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="4" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" parent="2" vertex="1">
|
||||
<mxGeometry y="51.28" width="350" height="8" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="5" value="+ GetById(id string): *sql.DB" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="2" vertex="1">
|
||||
<mxGeometry y="59.28" width="350" height="30" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="6" value="+ GetByParams(conninfo *DbConnInfo): string" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="2" vertex="1">
|
||||
<mxGeometry y="89.28" width="350" height="30" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="12" value="+ PutPreparedStatement(id string, stmt *sql.Stmt): string" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="2" vertex="1">
|
||||
<mxGeometry y="119.28" width="350" height="30" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="13" value="+ GetPreparedStatement(conn_id, stmt_id string): *sql.Stmt" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="2" vertex="1">
|
||||
<mxGeometry y="149.28" width="350" height="30" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="15" value="+ ClosePreparedStatement(conn_id, stmt_id string): bool" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="2" vertex="1">
|
||||
<mxGeometry y="179.28" width="350" height="30" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="10" value="+ Delete(id string)" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="2" vertex="1">
|
||||
<mxGeometry y="209.28" width="350" height="30" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="16" value="+ RunMaintenance()" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="2" vertex="1">
|
||||
<mxGeometry y="239.28" width="350" height="30" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="7" value="+ getNewConnection(*DbConnInfo, hash [32]byte): string" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="2" vertex="1">
|
||||
<mxGeometry y="269.28" width="350" height="30" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="17" value="<b>DbConn</b>" style="swimlane;fontStyle=0;childLayout=stackLayout;horizontal=1;startSize=26;fillColor=none;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
|
||||
<mxGeometry x="590" y="118" width="160" height="128.47" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="18" value="+ Hash: [32]byte" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="17" vertex="1">
|
||||
<mxGeometry y="26" width="160" height="26" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="19" value="+ DB: *sql.DB" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="17" vertex="1">
|
||||
<mxGeometry y="52" width="160" height="26" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="20" value="+ Timestamp: time.Time" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="17" vertex="1">
|
||||
<mxGeometry y="78" width="160" height="26" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="24" value="+ Stmt: []DbStmt" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="17" vertex="1">
|
||||
<mxGeometry y="104" width="160" height="24.47" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="31" style="edgeStyle=none;html=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;exitX=0;exitY=0.127;exitDx=0;exitDy=0;exitPerimeter=0;" parent="1" source="25" target="24" edge="1">
|
||||
<mxGeometry relative="1" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="25" value="<b>DbStmt</b>" style="swimlane;fontStyle=0;childLayout=stackLayout;horizontal=1;startSize=26;fillColor=none;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
|
||||
<mxGeometry x="800" y="220" width="140" height="104" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="26" value="+ Id: string" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="25" vertex="1">
|
||||
<mxGeometry y="26" width="140" height="26" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="27" value="+ Stmt: *sql.Stmt" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="25" vertex="1">
|
||||
<mxGeometry y="52" width="140" height="26" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="28" value="+ Timestamp: time.Time" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="25" vertex="1">
|
||||
<mxGeometry y="78" width="140" height="26" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="43" style="edgeStyle=none;html=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;exitX=-0.005;exitY=0.171;exitDx=0;exitDy=0;exitPerimeter=0;" parent="1" source="37" target="3" edge="1">
|
||||
<mxGeometry relative="1" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="37" value="stored items" style="swimlane;fontStyle=0;childLayout=stackLayout;horizontal=1;startSize=26;fillColor=none;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
|
||||
<mxGeometry x="400" y="66" width="140" height="78" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="38" value="+ key: string" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="37" vertex="1">
|
||||
<mxGeometry y="26" width="140" height="26" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="39" value="+ value: *DbConn" style="text;strokeColor=none;fillColor=none;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;whiteSpace=wrap;html=1;" parent="37" vertex="1">
|
||||
<mxGeometry y="52" width="140" height="26" as="geometry"/>
|
||||
</mxCell>
|
||||
<mxCell id="44" style="edgeStyle=none;html=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;exitX=-0.004;exitY=0.104;exitDx=0;exitDy=0;exitPerimeter=0;" parent="1" source="17" target="39" edge="1">
|
||||
<mxGeometry relative="1" as="geometry"/>
|
||||
</mxCell>
|
||||
</root>
|
||||
</mxGraphModel>
|
||||
</diagram>
|
||||
</mxfile>
|
||||
Reference in New Issue
Block a user