/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

generate ER-Diagram Graph

post

/sqlflow/generation/sqlflow/erdiagramSelectGraph

Authorizations

Query parameters

databasestring

database

dbvendorstring

dbvendor

defaultDatabasestring

defaultDatabase

defaultSchemastring

defaultSchema

defaultServerstring

defaultServer

jobIdstring

jobId

normalizeIdentifierboolean · default: true

normalizeIdentifier

schemastring

schema

serverstring

server

sessionIdstring

sessionId

shareboolean

whether generate the sharable URL for the result

sqltextstring

sqltext

tablestring

table

tokenstringrequired

token

userIdstringrequired

userId

Body

sqlfilestring · binary

sqlfile

Responses

application/json;charset=utf-8

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gudusoft.com/api/gspLive_backend/sqlflow/generation/sqlflow/erdiagramSelectGraph?token=text&userId=text' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: multipart/form-data'

200

201

401

403

404

200

text

OK

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

generate ER-Diagram Graph image

post

/sqlflow/generation/sqlflow/erdiagramSelectGraph/image

Authorizations

Query parameters

databasestring

database

dbvendorstring

dbvendor

defaultDatabasestring

defaultDatabase

defaultSchemastring

defaultSchema

defaultServerstring

defaultServer

jobIdstring

jobId

normalizeIdentifierboolean · default: true

normalizeIdentifier

schemastring

schema

serverstring

server

sessionIdstring

sessionId

sqltextstring

sqltext

tablestring

table

tokenstringrequired

token

userIdstringrequired

userId

Body

sqlfilestring · binary

sqlfile

Responses

image/pngimage/jpegimage/gif

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gudusoft.com/api/gspLive_backend/sqlflow/generation/sqlflow/erdiagramSelectGraph/image?token=text&userId=text' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: multipart/form-data'

200

201

401

403

404

200

image/png

image/jpeg

image/gif

image/png

text

OK

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"'