Skip to content
Arroyo Documentation
Docs
API reference
Search
documentation
Ctrl K
Docs
API reference
Navigation
Arroyo REST API
/
connection_tables
List all connection tables
GET
/v1/connection_tables
http://localhost:5115/api/v1/connection_tables
Copy page
|
Markdown
View as Markdown
Query parameters
starting_after
optional
string
limit
optional
integer
format:
int32
· minimum:
0
Returns
200
Got connection table collection
JSON
Expand all
Collapse all
data
array of
object
required
{
9 properties
}
config
unknown
required
connector
string
required
consumers
integer
required
format:
int32
· minimum:
0
created_at
integer
required
format:
int64
· minimum:
0
id
string
required
name
string
required
schema
object
required
{
7 properties
}
bad_data
optional
or null
{
2 variants
}
One of the following:
Fail
{
1 property
}
behavior
fail
required
}
Drop
{
1 property
}
behavior
drop
required
}
}
definition
optional
or null
{
3 variants
}
One of the following:
JsonSchema
{
2 properties
}
schema
string
required
type
json_schema
required
}
Protobuf
{
3 properties
}
schema
string
required
type
protobuf_schema
required
dependencies
optional
map of
string
}
Avro
{
2 properties
}
schema
string
required
type
avro_schema
required
}
}
fields
optional
array of
SourceField
{
4 properties · 14 variants
}
name
string
required
metadata_key
optional
string
or null
required
optional
boolean
sql_name
optional
string
or null
And one of the following:
Int32
{
1 property
}
type
int32
required
}
Int64
{
1 property
}
type
int64
required
}
UInt32
{
1 property
}
type
uint32
required
}
UInt64
{
1 property
}
type
uint64
required
}
Float32
{
1 property
}
type
float32
required
}
Float64
{
1 property
}
type
float64
required
}
Decimal128
{
3 properties
}
precision
integer
required
format:
int32
· minimum:
0
scale
integer
required
format:
int32
type
decimal128
required
}
Bool
{
1 property
}
type
bool
required
}
String
{
1 property
}
type
string
required
}
Bytes
{
1 property
}
type
bytes
required
}
Timestamp
{
2 properties
}
type
timestamp
required
unit
optional
second
or
millisecond
or
microsecond
or
nanosecond
}
Json
{
1 property
}
type
json
required
}
Struct
{
2 properties
}
fields
array of
SourceField
required
{
4 properties · 14 variants
}
name
string
required
metadata_key
optional
string
or null
required
optional
boolean
sql_name
optional
string
or null
And one of the following:
Int32
{
1 property
}
type
int32
required
}
Int64
{
1 property
}
type
int64
required
}
UInt32
{
1 property
}
type
uint32
required
}
UInt64
{
1 property
}
type
uint64
required
}
Float32
{
1 property
}
type
float32
required
}
Float64
{
1 property
}
type
float64
required
}
Decimal128
{
3 properties
}
precision
integer
required
format:
int32
· minimum:
0
scale
integer
required
format:
int32
type
decimal128
required
}
Bool
{
1 property
}
type
bool
required
}
String
{
1 property
}
type
string
required
}
Bytes
{
1 property
}
type
bytes
required
}
Timestamp
{
2 properties
}
type
timestamp
required
unit
optional
second
or
millisecond
or
microsecond
or
nanosecond
}
Json
{
1 property
}
type
json
required
}
Struct
List
{
2 properties
}
items
ListFieldItem
required
{
3 properties · 14 variants
}
name
optional
string
required
optional
boolean
sql_name
optional
string
or null
And one of the following:
Int32
{
1 property
}
type
int32
required
}
Int64
{
1 property
}
type
int64
required
}
UInt32
{
1 property
}
type
uint32
required
}
UInt64
{
1 property
}
type
uint64
required
}
Float32
{
1 property
}
type
float32
required
}
Float64
{
1 property
}
type
float64
required
}
Decimal128
{
3 properties
}
precision
integer
required
format:
int32
· minimum:
0
scale
integer
required
format:
int32
type
decimal128
required
}
Bool
{
1 property
}
type
bool
required
}
String
{
1 property
}
type
string
required
}
Bytes
{
1 property
}
type
bytes
required
}
Timestamp
{
2 properties
}
type
timestamp
required
unit
optional
second
or
millisecond
or
microsecond
or
nanosecond
}
Json
{
1 property
}
type
json
required
}
Struct
List
}
type
list
required
}
}
type
struct
required
}
List
{
2 properties
}
items
ListFieldItem
required
{
3 properties · 14 variants
}
name
optional
string
required
optional
boolean
sql_name
optional
string
or null
And one of the following:
Int32
{
1 property
}
type
int32
required
}
Int64
{
1 property
}
type
int64
required
}
UInt32
{
1 property
}
type
uint32
required
}
UInt64
{
1 property
}
type
uint64
required
}
Float32
{
1 property
}
type
float32
required
}
Float64
{
1 property
}
type
float64
required
}
Decimal128
{
3 properties
}
precision
integer
required
format:
int32
· minimum:
0
scale
integer
required
format:
int32
type
decimal128
required
}
Bool
{
1 property
}
type
bool
required
}
String
{
1 property
}
type
string
required
}
Bytes
{
1 property
}
type
bytes
required
}
Timestamp
{
2 properties
}
type
timestamp
required
unit
optional
second
or
millisecond
or
microsecond
or
nanosecond
}
Json
{
1 property
}
type
json
required
}
Struct
{
2 properties
}
fields
array of
SourceField
required
{
4 properties · 14 variants
}
name
string
required
metadata_key
optional
string
or null
required
optional
boolean
sql_name
optional
string
or null
And one of the following:
Int32
{
1 property
}
type
int32
required
}
Int64
{
1 property
}
type
int64
required
}
UInt32
{
1 property
}
type
uint32
required
}
UInt64
{
1 property
}
type
uint64
required
}
Float32
{
1 property
}
type
float32
required
}
Float64
{
1 property
}
type
float64
required
}
Decimal128
{
3 properties
}
precision
integer
required
format:
int32
· minimum:
0
scale
integer
required
format:
int32
type
decimal128
required
}
Bool
{
1 property
}
type
bool
required
}
String
{
1 property
}
type
string
required
}
Bytes
{
1 property
}
type
bytes
required
}
Timestamp
{
2 properties
}
type
timestamp
required
unit
optional
second
or
millisecond
or
microsecond
or
nanosecond
}
Json
{
1 property
}
type
json
required
}
Struct
List
}
type
struct
required
}
List
}
type
list
required
}
}
format
optional
or null
{
6 variants
}
One of the following:
Json
{
9 properties
}
type
json
required
compression
optional
uncompressed
or
gzip
confluent_schema_registry
optional
boolean
debezium
optional
boolean
decimal_encoding
optional
number
or
string
or
bytes
include_schema
optional
boolean
schema_id
optional
integer
or null
format:
int32
· minimum:
0
timestamp_format
optional
rfc3339
or
unix_millis
unstructured
optional
boolean
}
Avro
{
6 properties
}
type
avro
required
confluent_schema_registry
optional
boolean
into_unstructured_json
optional
boolean
raw_datums
optional
boolean
reader_schema
optional
string
schema_id
optional
integer
or null
format:
int32
· minimum:
0
}
Protobuf
{
6 properties
}
type
protobuf
required
compiled_schema
optional
string
or null
format:
binary
confluent_schema_registry
optional
boolean
into_unstructured_json
optional
boolean
length_delimited
optional
boolean
message_name
optional
string
or null
}
Parquet
{
3 properties
}
type
parquet
required
compression
optional
uncompressed
or
snappy
or
gzip
or
zstd
or
lz4
or
lz4_raw
row_group_bytes
optional
integer
or null
format:
int64
· minimum:
0
}
RawString
{
1 property
}
type
raw_string
required
}
RawBytes
{
1 property
}
type
raw_bytes
required
}
}
framing
optional
or null
{
1 variant
}
One of the following:
Newline
{
2 properties
}
method
newline
required
max_line_length
optional
integer
or null
format:
int64
· minimum:
0
}
}
inferred
optional
boolean
or null
primary_keys
optional
array of
string
}
table_type
source
or
sink
or
lookup
required
connection_profile
optional
object
or null
{
5 properties
}
config
unknown
required
connector
string
required
description
string
required
id
string
required
name
string
required
}
}
hasMore
boolean
required
[
Previous
connection_tables
Next
Create a new connection table
]
Esc
Type to search…
↑↓ navigate
↵ select
Esc close
Single-key shortcuts
/ [ ]