Update a transform

POST /_transform/{transform_id}/_update

Updates certain properties of a transform.

All updated properties except description do not take effect until after the transform starts the next checkpoint, thus there is data consistency in each checkpoint. To use this API, you must have read and view_index_metadata privileges for the source indices. You must also have index and read privileges for the destination index. When Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the time of update and runs with those privileges.

Required authorization

Index privileges: read,index,view_index_metadata
Cluster privileges: manage_transform

Path Parameters

transform_id string Id required: Identifier for the transform.

Run POST _transform/simple-kibana-ecomm-pivot/_update to update a transform that uses the pivot method.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST _transform/simple-kibana-ecomm-pivot/_update
{
  "source": {
    "index": "kibana_sample_data_ecommerce",
    "query": {
      "term": {
        "geoip.continent_name": {
          "value": "Asia"
        }
      }
    }
  },
  "description": "Maximum priced ecommerce data by customer_id in Asia",
  "dest": {
    "index": "kibana_sample_data_ecommerce_transform_v2",
    "pipeline": "add_timestamp_pipeline"
  },
  "frequency": "15m",
  "sync": {
    "time": {
      "field": "order_date",
      "delay": "120s"
    }
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.transform.updateTransform({
  transform_id: "simple-kibana-ecomm-pivot",
  source: {
    index: "kibana_sample_data_ecommerce",
    query: {
      term: {
        "geoip.continent_name": {
          value: "Asia",
        },
      },
    },
  },
  description: "Maximum priced ecommerce data by customer_id in Asia",
  dest: {
    index: "kibana_sample_data_ecommerce_transform_v2",
    pipeline: "add_timestamp_pipeline",
  },
  frequency: "15m",
  sync: {
    time: {
      field: "order_date",
      delay: "120s",
    },
  },
});

Python Elasticsearch Python Client

resp = client.transform.update_transform(
    transform_id="simple-kibana-ecomm-pivot",
    source={
        "index": "kibana_sample_data_ecommerce",
        "query": {
            "term": {
                "geoip.continent_name": {
                    "value": "Asia"
                }
            }
        }
    },
    description="Maximum priced ecommerce data by customer_id in Asia",
    dest={
        "index": "kibana_sample_data_ecommerce_transform_v2",
        "pipeline": "add_timestamp_pipeline"
    },
    frequency="15m",
    sync={
        "time": {
            "field": "order_date",
            "delay": "120s"
        }
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_transform/simple-kibana-ecomm-pivot/_update" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source": {
      "index": "kibana_sample_data_ecommerce",
      "query": {
        "term": {
          "geoip.continent_name": {
            "value": "Asia"
          }
        }
      }
    },
    "description": "Maximum priced ecommerce data by customer_id in Asia",
    "dest": {
      "index": "kibana_sample_data_ecommerce_transform_v2",
      "pipeline": "add_timestamp_pipeline"
    },
    "frequency": "15m",
    "sync": {
      "time": {
        "field": "order_date",
        "delay": "120s"
      }
    }
  }'

Java Elasticsearch Java Client

client.transform().updateTransform(u -> u
    .description("Maximum priced ecommerce data by customer_id in Asia")
    .dest(d -> d
        .index("kibana_sample_data_ecommerce_transform_v2")
        .pipeline("add_timestamp_pipeline")
    )
    .frequency(f -> f
        .time("15m")
    )
    .source(s -> s
        .index("kibana_sample_data_ecommerce")
        .query(q -> q
            .term(t -> t
                .field("geoip.continent_name")
                .value(FieldValue.of("Asia"))
            )
        )
    )
    .sync(sy -> sy
        .time(t -> t
            .delay(d -> d
                .time("120s")
            )
            .field("order_date")
        )
    )
    .transformId("simple-kibana-ecomm-pivot")
);

C# Elasticsearch .NET Client

var response = await client.TransformManagement
    .UpdateTransformAsync(transformId: "simple-kibana-ecomm-pivot", d1 => d1
        .Description("Maximum priced ecommerce data by customer_id in Asia")
        .Dest(d2 => d2
            .Index("kibana_sample_data_ecommerce_transform_v2")
            .Pipeline("add_timestamp_pipeline")
        )
        .Frequency("15m")
        .Source(d2 => d2
            .Indices(new[] { "kibana_sample_data_ecommerce" })
            .Query(d3 => d3
                .Term(d4 => d4
                    .Field(x => x.Geoip.ContinentName)
                    .Value("Asia")
                )
            )
        )
        .Sync(d2 => d2
            .Time(d3 => d3
                .Delay("120s")
                .Field(x => x.OrderDate)
            )
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->transform()->updateTransform([
    "transform_id" => "simple-kibana-ecomm-pivot",
    "body" => [
        "source" => [
            "index" => "kibana_sample_data_ecommerce",
            "query" => [
                "term" => [
                    "geoip.continent_name" => [
                        "value" => "Asia",
                    ],
                ],
            ],
        ],
        "description" => "Maximum priced ecommerce data by customer_id in Asia",
        "dest" => [
            "index" => "kibana_sample_data_ecommerce_transform_v2",
            "pipeline" => "add_timestamp_pipeline",
        ],
        "frequency" => "15m",
        "sync" => [
            "time" => [
                "field" => "order_date",
                "delay" => "120s",
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.transform.update_transform(
  transform_id: "simple-kibana-ecomm-pivot",
  body: {
    "source": {
      "index": "kibana_sample_data_ecommerce",
      "query": {
        "term": {
          "geoip.continent_name": {
            "value": "Asia"
          }
        }
      }
    },
    "description": "Maximum priced ecommerce data by customer_id in Asia",
    "dest": {
      "index": "kibana_sample_data_ecommerce_transform_v2",
      "pipeline": "add_timestamp_pipeline"
    },
    "frequency": "15m",
    "sync": {
      "time": {
        "field": "order_date",
        "delay": "120s"
      }
    }
  }
)

Response

{
  "id": "simple-kibana-ecomm-pivot",
  "authorization": {
    "roles": [
      "superuser"
    ]
  },
  "version": "10.0.0",
  "create_time": 1712951576767,
  "source": {
    "index": [
      "kibana_sample_data_ecommerce"
    ],
    "query": {
      "term": {
        "geoip.continent_name": {
          "value": "Asia"
        }
      }
    }
  },
  "dest": {
    "index": "kibana_sample_data_ecommerce_transform_v2",
    "pipeline": "add_timestamp_pipeline"
  },
  "frequency": "15m",
  "sync": {
    "time": {
      "field": "order_date",
      "delay": "120s"
    }
  },
  "pivot": {
    "group_by": {
      "customer_id": {
        "terms": {
          "field": "customer_id",
          "missing_bucket": true
        }
      }
    },
    "aggregations": {
      "max_price": {
        "max": {
          "field": "taxful_total_price"
        }
      }
    }
  },
  "description": "Maximum priced ecommerce data by customer_id in Asia",
  "settings": {},
  "retention_policy": {
    "time": {
      "field": "order_date",
      "max_age": "30d"
    }
  }
}

Required authorization

Path Parameters

Query Parameters { defer_validation , timeout , }

Request { dest , description , frequency , _meta , source , settings , sync , retention_policy , }

Response

Query Parameters

Request