Skip to main content
GET
ListJoinPatterns

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

entityId
string

The synq path of the table, view or model to list the join patterns of, as the paths of BatchSqlDetailsRequest take it.

Required string length: 1 - 4096
column
string

Set to return only the patterns whose key compares this column of the entity, like customer_id. Matched case-insensitively. Leave empty for every column.

Maximum string length: 4096
otherEntityId
string

Set to return only how the entity is joined with this other entity, which answers "how do I join these two tables". A key that also compares a third table keeps only its comparisons with this one. Like entity_id, it matches every entity that is the same object. Leave empty for joins with any entity.

Maximum string length: 4096
queryLog.from.seconds

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.

queryLog.from.nanos
integer<int32>

Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.

queryLog.minQueries

A pattern seen only in the query history is listed when it reaches any of these thresholds that is set. 0 sets none, and with none set every pattern is listed. A pattern that a SQL definition makes is always listed.

queryLog.minLogins
integer
bareOnly
boolean

Set to return only the patterns whose every side is a plain column, with no expression around it, like lower(email) or a cast.

Response

200 - application/json

Success

ListJoinPatternsResponse lists the join patterns of the requested entity.

patterns
JoinPattern · object[]

The join patterns. Those that a SQL definition makes come first, then those of the query history only, by distinct logins, the last hour seen and queries. Empty when no SQL in the workspace joins the entity, or none was parsed yet.

queryLogCoveredHours
integer

How many hours of the query_log window the query history covered in full. 0 with no QUERY_LOG pattern means that no query history was read for the window, not that no query made a join.