Sinks¶
Sinks are at the receiving end of pipes and are responsible for writing entities into an internal dataset or a target system.
Sinks can support batching by implementing specific methods and
accumulating entities in a buffer before writing the batch. The size of
each batch can be specified using the batch_size property on the
pipe. See the section on batching for more
information.
Prototype¶
The following JSON snippet shows the general form of a sink definition.
{
"type": "a-sink-type",
"comment": "This is a comment"
}
The only universally required property is type.
Properties¶
Property |
Type |
Description |
Default |
Req |
|---|---|---|---|---|
|
String |
The type of the sink, the allowed types are described below |
Yes |
|
|
String or list of strings |
A human readable comment on the sink (optional). |