amoghrajesh commented on code in PR #68283: URL: https://github.com/apache/airflow/pull/68283#discussion_r3496778028
########## providers/common/io/docs/state_store_backend.rst: ########## @@ -0,0 +1,80 @@ +.. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +Object Storage State Store Backend +=================================== + +The default state store backend is :class:`~airflow.state.metastore.MetastoreStateBackend`, which persists +task and asset state in the Airflow metadata database via the API Server's Execution API. For larger values, you may want to store state on object storage directly from the task instead. + +To enable object storage for task and asset state store, set ``state_store_backend`` in the ``[workers]`` +section to ``airflow.providers.common.io.state_store.backend.StateStoreObjectStorageBackend``, and set +``state_store_objectstorage_path`` to the desired base location. The connection id is obtained from the user +part of the URL, e.g. ``state_store_objectstorage_path = s3://conn_id@mybucket/task-state/``. Review Comment: Good point on the naming, but changing it now would make these keys inconsistent with the existing xcom config keys (xcom_objectstorage_path, xcom_objectstorage_threshold, xcom_objectstorage_compression) which follow the same objectstorage pattern. Keeping them this way to avoid confusion. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
