.. _insertfield:

===========
InsertField
===========

Description
-----------
Insert fields using attributes from the record metadata or a configured static value.

Use the concrete transformation type designed for the record key (``org.apache.kafka.connect.transforms.InsertField$Key``) or value (``org.apache.kafka.connect.transforms.InsertField$Value``).


Properties
----------

.. list-table::
   :header-rows: 1
   :widths: 15 30 10 10 10 10

   *  - Name
      - Description
      - Type
      - Default
      - Valid Values
      - Importance
   *  - ``offset.field``
      - Field name for Kafka offset. This is only applicable to sink connectors. Suffix with ``!`` to make this a required field, or ``?`` to keep it optional (the default).
      - string
      - null
      -
      - medium
   *  - ``partition.field``
      - Field name for Kafka partition. Suffix with ``!`` to make this a required field, or ``?`` to keep it optional (the default).
      - string
      - null
      -
      - medium
   *  - ``static.field``
      - Field name for static data field. Suffix with ``!`` to make this a required field, or ``?`` to keep it optional (the default).
      - string
      - null
      -
      - medium
   *  - ``static.value``
      - If field name is configured, the static field value.
      - string
      - null
      -
      - medium
   *  - ``timestamp.field``
      - Field name for record timestamp. Suffix with ``!`` to make this a required field, or ``?`` to keep it optional (the default).
      - string
      - null
      -
      - medium
   *  - ``topic.field``
      - Field name for Kafka topic. Suffix with ``!`` to make this a required field, or ``?`` to keep it optional (the default).
      - string
      - null
      -
      - medium