/sqlflow/erdiagramSelectGraph

Show the E-R Diagram based on the given source (sqltext/sessionId). Check here for more information about this feature in SQLFlow UI.

Retrieve E-R Diagram in Json

/sqlflow/generation/sqlflow/erdiagramSelectGraph

generate ER-Diagram Graph

post

generate ER-Diagram Graph

Authorizations
Query parameters
databasestringOptional

database

dbvendorstringOptional

dbvendor

defaultDatabasestringOptional

defaultDatabase

defaultSchemastringOptional

defaultSchema

defaultServerstringOptional

defaultServer

jobIdstringOptional

jobId

normalizeIdentifierbooleanOptional

normalizeIdentifier

Default: true
schemastringOptional

schema

serverstringOptional

server

sessionIdstringOptional

sessionId

sharebooleanOptional

whether generate the sharable URL for the result

Default: false
sqltextstringOptional

sqltext

tablestringOptional

table

tokenstringRequired

token

userIdstringRequired

userId

Body
sqlfilestring · binaryOptional

sqlfile

Responses
200
OK
application/json;charset=utf-8
Responsestring
post
POST /api/gspLive_backend/sqlflow/generation/sqlflow/erdiagramSelectGraph HTTP/1.1
Host: api.gudusoft.com
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 20

{
  "sqlfile": "binary"
}
text

Sample:

curl --location 'https://<SQLFLOW URL>/gspLive_backend/sqlflow/generation/sqlflow/erdiagramSelectGraph' \
--header 'accept: application/json' \
--form 'userId="gudu|0123456789"' \
--form 'sessionId="85b5119f83fcfefa93136e79dc05f2f61efe3b75e6a2b733568e0879c24f0c08_1680615728918"' \
--form 'dbvendor="dbvmssql"' \
--form 'jobId="6def00e8796e4c20ba216826c0ab5b73"' \
--form 'databse="hr"' \
--form 'schema="dbo"'

Retrieve E-R Diagram image

/sqlflow/generation/sqlflow/erdiagramSelectGraph/image

generate ER-Diagram Graph image

post

generate ER-Diagram Graph image

Authorizations
Query parameters
databasestringOptional

database

dbvendorstringOptional

dbvendor

defaultDatabasestringOptional

defaultDatabase

defaultSchemastringOptional

defaultSchema

defaultServerstringOptional

defaultServer

jobIdstringOptional

jobId

normalizeIdentifierbooleanOptional

normalizeIdentifier

Default: true
schemastringOptional

schema

serverstringOptional

server

sessionIdstringOptional

sessionId

sqltextstringOptional

sqltext

tablestringOptional

table

tokenstringRequired

token

userIdstringRequired

userId

Body
sqlfilestring · binaryOptional

sqlfile

Responses
200
OK
Responsestring · byte
post
POST /api/gspLive_backend/sqlflow/generation/sqlflow/erdiagramSelectGraph/image HTTP/1.1
Host: api.gudusoft.com
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 20

{
  "sqlfile": "binary"
}
Ynl0ZXM=

Sample:

curl --location 'https://<SQLFLOW URL>/gspLive_backend/sqlflow/generation/sqlflow/erdiagramSelectGraph/image' \
--header 'accept: image/*' \
--form 'userId="gudu|0123456789"' \
--form 'sessionId="85b5119f83fcfefa93136e79dc05f2f61efe3b75e6a2b733568e0879c24f0c08_1680615728918"' \
--form 'dbvendor="dbvmssql"' \
--form 'jobId="6def00e8796e4c20ba216826c0ab5b73"' \
--form 'databse="hr"' \
--form 'schema="dbo"'

Last updated