JSON Source for Event Data

This page lists the data types and source formats supported by Data Factory Studio for the Index Event Data pipeline.

Event pipelines enable updating an index more incrementally. For example, if only a few items have changed in your source data, you can easily update these specific items only.

Event pipelines also provide extra control on your Index Unit, like deleting items individually or with a predicate.

This page discusses:

See Also
Indexing Event Data

Expected JSON File Format

Ingested JSON files must represent a JSON array of JSON objects, each of these objects representing one event.

All events must define an action property specifying its type, and some required properties depending on the selected action.

[
  {
    "action": "AddOrReplaceItem",
    "item": {
      "...": "..."
    }
  },
  ...
  {
    "action": "DeleteItem",
    "uri": "..."
  }
]

Supported Action Description
AddOrReplaceItem Indexes an item.

Expected property:

item: A JSON object. The expected format for that item is the same as for items in the JSON Source for Tabular Data.
DeleteItem Deletes an item from the Index Unit.

Expected property:

uri: A JSON string, that is the identifier of the item to delete.

Examples

Add Item

[
  {
    "action": "AddOrReplaceItem",
    "item": {
      "uri": "abcd123",
      "class": "com.example.MockClass",
      "a_bool": true,
      "a_date": "1111-01-11"
    }
  },
  {
    "action": "AddOrReplaceItem",
    "item": {
      "uri": "def546",
      "class": "com.example.MockClass",
      "a_bool": false,
      "a_date": "2222-02-22"
    }
  },
  {
    "action": "AddOrReplaceItem",
    "item": {
      "uri": "ghi789",
      "class": "com.example.MockClass",
      "a_bool": true,
      "a_date": "3333-03-33"
    }
  }
]

Delete Item

[
  {
    "action": "DeleteItem",
    "uri": "abcd123"
  },
  {
    "action": "DeleteItem",
    "uri": "ghi789"
  }
]