đź”—Snapshot Avro


A batch source that reads from a corresponding SnapshotAvro sink. The source will only read the most recent snapshot written to the sink.

đź”—Use Case

This source is used whenever you want to read data written to the corresponding SnapshotAvro sink. It will read only the last snapshot written to that sink. For example, you might want to create daily snapshots of a database by reading the entire contents of a table and writing it to a SnapshotAvro sink. You might then want to use this source to read the most recent snapshot and run some data analysis on it.


name: Name of the PartitionedFileSet to which records are written. If it doesn't exist, it will be created. (Macro-enabled)

schema: The Avro schema of the record being written to the sink as a JSON object.

basePath: Base path for the PartitionedFileSet. Defaults to the name of the dataset. (Macro-enabled)

fileProperties: Advanced feature to specify any additional properties that should be used with the sink, specified as a JSON object of string to string. These properties are set on the dataset if one is created. The properties are also passed to the dataset at runtime as arguments. (Macro-enabled)


This example will read from a SnapshotFileSet named 'users'. It will read data in Avro format using the given schema. Every time the pipeline runs, only the most recently added snapshot will be read:

    "name": "SnapshotAvro",
    "type": "batchsource",
    "properties": {
        "name": "users",
        "schema": "{

  • CDAP Pipelines Plugin Type: batchsource
  • CDAP Pipelines Version: 1.6.2-SNAPSHOT