Version 4.0.24.16 (latest)
Connection cost estimating
Assign a sql
statement to the body of the request. e.g., for Ruby, {sql: 'select * from users'}
Note: If the connection's dialect has no support for cost estimates, an error will be returned
Request
POST
/connections/{connection_name}/cost_estimate
Datatype
Description
Request
path
Expand HTTP Path definition...
connection_name
Name of connection
body
Expand HTTP Body definition...
body
SQL statement to estimate
Expand CreateCostEstimate definition...
sql
lock
SQL statement to estimate
query
Expand HTTP Query definition...
fields
Requested fields.
Response
200: Connection cost estimates
Datatype
Description
(object)
cost
lock
Cost of SQL statement
cache_hit
lock
Does the result come from the cache?
cost_unit
lock
Cost measurement size
message
lock
Human-friendly message
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link