You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/11/08 20:57:02 UTC
[GitHub] [airflow] jedcunningham commented on a change in pull request #19453: Improve message and documentation around moved data
jedcunningham commented on a change in pull request #19453:
URL: https://github.com/apache/airflow/pull/19453#discussion_r745078133
##########
File path: airflow/www/templates/airflow/dags.html
##########
@@ -57,7 +57,8 @@
Airflow found incompatible data in the <code>{{ original_table_name }}</code> table in the
Review comment:
```suggestion
<p>Airflow found incompatible data in the <code>{{ original_table_name }}</code> table in the
```
If we are going to close a paragraph, we should start one too.
##########
File path: docs/apache-airflow/installation/upgrading.rst
##########
@@ -0,0 +1,77 @@
+ .. 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.
+
+Upgrading Airflow to a newer version
+------------------------------------
+
+When you are upgrading Airflow you should always upgrade the metadata DB as part of the upgrade
+process. This might happen automatically in some cases.
+For example when you are using :doc:`helm-chart:index` with post-upgrade hooks enabled, the database
+upgrade happens automatically after upgrade is completed. Similarly all Airflow-As-A-Service solutions
+run the upgrade automatically for you.
+
+However if you have your custom deployment based on virtualenv or Docker Containers, you need to run
Review comment:
```suggestion
However if you have a custom deployment based on virtualenv or Docker Containers, you need to run
```
##########
File path: docs/apache-airflow/installation/upgrading.rst
##########
@@ -0,0 +1,77 @@
+ .. 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.
+
+Upgrading Airflow to a newer version
+------------------------------------
+
+When you are upgrading Airflow you should always upgrade the metadata DB as part of the upgrade
+process. This might happen automatically in some cases.
+For example when you are using :doc:`helm-chart:index` with post-upgrade hooks enabled, the database
+upgrade happens automatically after upgrade is completed. Similarly all Airflow-As-A-Service solutions
+run the upgrade automatically for you.
Review comment:
```suggestion
upgrade happens automatically after the helm upgrade is completed. Similarly all Airflow-As-A-Service
solutions run the upgrade automatically for you.
```
##########
File path: docs/apache-airflow/installation/upgrading.rst
##########
@@ -0,0 +1,77 @@
+ .. 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.
+
+Upgrading Airflow to a newer version
+------------------------------------
+
+When you are upgrading Airflow you should always upgrade the metadata DB as part of the upgrade
+process. This might happen automatically in some cases.
+For example when you are using :doc:`helm-chart:index` with post-upgrade hooks enabled, the database
+upgrade happens automatically after upgrade is completed. Similarly all Airflow-As-A-Service solutions
+run the upgrade automatically for you.
+
+However if you have your custom deployment based on virtualenv or Docker Containers, you need to run
+the DB upgrade manually as part of the upgrade process.
+
+In order to manually upgrade the database you should run ``airflow db upgrade`` command in your environment
+(either in your virtual environment or in your containers that gives you access to Airflow ``CLI``:
+:doc:`/usage-cli` and the database.
+
+Depending on the size of your database and the actual migration it might take quite some time to migrate it,
+so if you have long history and big database, it is recommended to make a copy of the database first and
+perform test migration to assess how long the migration will take. Typically "Major" upgrades might take
+longer as adding new features require sometimes restructuring of the database.
+
+Post-upgrade warning messages
+-----------------------------
+
+Typically you just need to successfully run ``airflow db upgrade`` command and this is all. However in
+some cases, the migration might find some old, stale and probably wrong data in your database and move it
+aside to a separate table. In this case you might get warning in your webserver UI about the data found.
+
+Typical message that you might see:
+
+ Airflow found incompatible data in the <original table> table in the
+ metadatabase, and has moved them to <new table> during the database migration to upgrade.
+ Please inspect the moved data to decide whether you need to keep them,
+ and manually drop the <new table> table to dismiss this warning.
+
+When you see such message, it means that some of your data was corrupted and you should inspect it
+whether you would like to keep or move some of that data. Most likely the data was really corrupted
+and left-over from some bugs and can be safely deleted - because this data would not be anyhow visible
+and useful in Airflow. However if you have particular need for auditing or historical reasons you might
+choose to store it somewhere. Unless you have specific reasons to keep the data most likely deleting it
+is your best option.
+
+There are various ways you can inspect and delete the data - if you have direct access to the
+database using your own tools (often graphical tools showing the database objects), you can drop such
+table or rename it or moving to another database using those tools. If you don't have such tools you
Review comment:
```suggestion
table or rename it or move it to another database using those tools. If you don't have such tools you
```
##########
File path: docs/apache-airflow/installation/upgrading.rst
##########
@@ -0,0 +1,77 @@
+ .. 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.
+
+Upgrading Airflow to a newer version
+------------------------------------
+
+When you are upgrading Airflow you should always upgrade the metadata DB as part of the upgrade
+process. This might happen automatically in some cases.
+For example when you are using :doc:`helm-chart:index` with post-upgrade hooks enabled, the database
+upgrade happens automatically after upgrade is completed. Similarly all Airflow-As-A-Service solutions
+run the upgrade automatically for you.
+
+However if you have your custom deployment based on virtualenv or Docker Containers, you need to run
+the DB upgrade manually as part of the upgrade process.
+
+In order to manually upgrade the database you should run ``airflow db upgrade`` command in your environment
Review comment:
```suggestion
In order to manually upgrade the database you should run the ``airflow db upgrade`` command in your environment
```
##########
File path: docs/apache-airflow/installation/upgrading.rst
##########
@@ -0,0 +1,77 @@
+ .. 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.
+
+Upgrading Airflow to a newer version
+------------------------------------
+
+When you are upgrading Airflow you should always upgrade the metadata DB as part of the upgrade
+process. This might happen automatically in some cases.
+For example when you are using :doc:`helm-chart:index` with post-upgrade hooks enabled, the database
+upgrade happens automatically after upgrade is completed. Similarly all Airflow-As-A-Service solutions
+run the upgrade automatically for you.
+
+However if you have your custom deployment based on virtualenv or Docker Containers, you need to run
+the DB upgrade manually as part of the upgrade process.
+
+In order to manually upgrade the database you should run ``airflow db upgrade`` command in your environment
+(either in your virtual environment or in your containers that gives you access to Airflow ``CLI``:
+:doc:`/usage-cli` and the database.
+
+Depending on the size of your database and the actual migration it might take quite some time to migrate it,
+so if you have long history and big database, it is recommended to make a copy of the database first and
+perform test migration to assess how long the migration will take. Typically "Major" upgrades might take
+longer as adding new features require sometimes restructuring of the database.
+
+Post-upgrade warning messages
+-----------------------------
+
+Typically you just need to successfully run ``airflow db upgrade`` command and this is all. However in
+some cases, the migration might find some old, stale and probably wrong data in your database and move it
+aside to a separate table. In this case you might get warning in your webserver UI about the data found.
+
+Typical message that you might see:
+
+ Airflow found incompatible data in the <original table> table in the
+ metadatabase, and has moved them to <new table> during the database migration to upgrade.
+ Please inspect the moved data to decide whether you need to keep them,
+ and manually drop the <new table> table to dismiss this warning.
+
+When you see such message, it means that some of your data was corrupted and you should inspect it
+whether you would like to keep or move some of that data. Most likely the data was really corrupted
+and left-over from some bugs and can be safely deleted - because this data would not be anyhow visible
+and useful in Airflow. However if you have particular need for auditing or historical reasons you might
+choose to store it somewhere. Unless you have specific reasons to keep the data most likely deleting it
+is your best option.
+
+There are various ways you can inspect and delete the data - if you have direct access to the
+database using your own tools (often graphical tools showing the database objects), you can drop such
+table or rename it or moving to another database using those tools. If you don't have such tools you
+can use ``airflow db shell`` command - this will drop you in the db shell tool for your database and you
+will be able to both inspect and delete the table (Replace ``<table>`` in the examples with the actual
+table name as printed in the warning message.
Review comment:
```suggestion
table name as printed in the warning message).
```
##########
File path: docs/apache-airflow/installation/upgrading.rst
##########
@@ -0,0 +1,77 @@
+ .. 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.
+
+Upgrading Airflow to a newer version
+------------------------------------
+
+When you are upgrading Airflow you should always upgrade the metadata DB as part of the upgrade
+process. This might happen automatically in some cases.
+For example when you are using :doc:`helm-chart:index` with post-upgrade hooks enabled, the database
+upgrade happens automatically after upgrade is completed. Similarly all Airflow-As-A-Service solutions
+run the upgrade automatically for you.
+
+However if you have your custom deployment based on virtualenv or Docker Containers, you need to run
+the DB upgrade manually as part of the upgrade process.
+
+In order to manually upgrade the database you should run ``airflow db upgrade`` command in your environment
+(either in your virtual environment or in your containers that gives you access to Airflow ``CLI``:
+:doc:`/usage-cli` and the database.
+
+Depending on the size of your database and the actual migration it might take quite some time to migrate it,
+so if you have long history and big database, it is recommended to make a copy of the database first and
+perform test migration to assess how long the migration will take. Typically "Major" upgrades might take
+longer as adding new features require sometimes restructuring of the database.
+
+Post-upgrade warning messages
+-----------------------------
+
+Typically you just need to successfully run ``airflow db upgrade`` command and this is all. However in
+some cases, the migration might find some old, stale and probably wrong data in your database and move it
+aside to a separate table. In this case you might get warning in your webserver UI about the data found.
+
+Typical message that you might see:
+
+ Airflow found incompatible data in the <original table> table in the
+ metadatabase, and has moved them to <new table> during the database migration to upgrade.
+ Please inspect the moved data to decide whether you need to keep them,
+ and manually drop the <new table> table to dismiss this warning.
+
+When you see such message, it means that some of your data was corrupted and you should inspect it
+whether you would like to keep or move some of that data. Most likely the data was really corrupted
+and left-over from some bugs and can be safely deleted - because this data would not be anyhow visible
+and useful in Airflow. However if you have particular need for auditing or historical reasons you might
+choose to store it somewhere. Unless you have specific reasons to keep the data most likely deleting it
+is your best option.
+
+There are various ways you can inspect and delete the data - if you have direct access to the
+database using your own tools (often graphical tools showing the database objects), you can drop such
+table or rename it or moving to another database using those tools. If you don't have such tools you
+can use ``airflow db shell`` command - this will drop you in the db shell tool for your database and you
Review comment:
```suggestion
can use the ``airflow db shell`` command - this will drop you in the db shell tool for your database and you
```
##########
File path: docs/apache-airflow/installation/upgrading.rst
##########
@@ -0,0 +1,77 @@
+ .. 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.
+
+Upgrading Airflow to a newer version
+------------------------------------
+
+When you are upgrading Airflow you should always upgrade the metadata DB as part of the upgrade
+process. This might happen automatically in some cases.
+For example when you are using :doc:`helm-chart:index` with post-upgrade hooks enabled, the database
+upgrade happens automatically after upgrade is completed. Similarly all Airflow-As-A-Service solutions
+run the upgrade automatically for you.
+
+However if you have your custom deployment based on virtualenv or Docker Containers, you need to run
+the DB upgrade manually as part of the upgrade process.
+
+In order to manually upgrade the database you should run ``airflow db upgrade`` command in your environment
+(either in your virtual environment or in your containers that gives you access to Airflow ``CLI``:
+:doc:`/usage-cli` and the database.
+
+Depending on the size of your database and the actual migration it might take quite some time to migrate it,
+so if you have long history and big database, it is recommended to make a copy of the database first and
+perform test migration to assess how long the migration will take. Typically "Major" upgrades might take
+longer as adding new features require sometimes restructuring of the database.
+
+Post-upgrade warning messages
+-----------------------------
+
+Typically you just need to successfully run ``airflow db upgrade`` command and this is all. However in
+some cases, the migration might find some old, stale and probably wrong data in your database and move it
Review comment:
```suggestion
some cases, the migration might find some old, stale and probably wrong data in your database and moves it
```
##########
File path: docs/apache-airflow/installation/upgrading.rst
##########
@@ -0,0 +1,77 @@
+ .. 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.
+
+Upgrading Airflow to a newer version
+------------------------------------
+
+When you are upgrading Airflow you should always upgrade the metadata DB as part of the upgrade
+process. This might happen automatically in some cases.
+For example when you are using :doc:`helm-chart:index` with post-upgrade hooks enabled, the database
+upgrade happens automatically after upgrade is completed. Similarly all Airflow-As-A-Service solutions
+run the upgrade automatically for you.
+
+However if you have your custom deployment based on virtualenv or Docker Containers, you need to run
+the DB upgrade manually as part of the upgrade process.
+
+In order to manually upgrade the database you should run ``airflow db upgrade`` command in your environment
+(either in your virtual environment or in your containers that gives you access to Airflow ``CLI``:
+:doc:`/usage-cli` and the database.
+
+Depending on the size of your database and the actual migration it might take quite some time to migrate it,
+so if you have long history and big database, it is recommended to make a copy of the database first and
+perform test migration to assess how long the migration will take. Typically "Major" upgrades might take
+longer as adding new features require sometimes restructuring of the database.
+
+Post-upgrade warning messages
+-----------------------------
+
+Typically you just need to successfully run ``airflow db upgrade`` command and this is all. However in
Review comment:
```suggestion
Typically you just need to successfully run the ``airflow db upgrade`` command and this is all. However in
```
##########
File path: docs/apache-airflow/installation/upgrading.rst
##########
@@ -0,0 +1,77 @@
+ .. 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.
+
+Upgrading Airflow to a newer version
+------------------------------------
+
+When you are upgrading Airflow you should always upgrade the metadata DB as part of the upgrade
+process. This might happen automatically in some cases.
+For example when you are using :doc:`helm-chart:index` with post-upgrade hooks enabled, the database
+upgrade happens automatically after upgrade is completed. Similarly all Airflow-As-A-Service solutions
+run the upgrade automatically for you.
+
+However if you have your custom deployment based on virtualenv or Docker Containers, you need to run
+the DB upgrade manually as part of the upgrade process.
+
+In order to manually upgrade the database you should run ``airflow db upgrade`` command in your environment
+(either in your virtual environment or in your containers that gives you access to Airflow ``CLI``:
+:doc:`/usage-cli` and the database.
+
+Depending on the size of your database and the actual migration it might take quite some time to migrate it,
+so if you have long history and big database, it is recommended to make a copy of the database first and
+perform test migration to assess how long the migration will take. Typically "Major" upgrades might take
+longer as adding new features require sometimes restructuring of the database.
+
+Post-upgrade warning messages
+-----------------------------
+
+Typically you just need to successfully run ``airflow db upgrade`` command and this is all. However in
+some cases, the migration might find some old, stale and probably wrong data in your database and move it
+aside to a separate table. In this case you might get warning in your webserver UI about the data found.
+
+Typical message that you might see:
+
+ Airflow found incompatible data in the <original table> table in the
+ metadatabase, and has moved them to <new table> during the database migration to upgrade.
+ Please inspect the moved data to decide whether you need to keep them,
+ and manually drop the <new table> table to dismiss this warning.
+
+When you see such message, it means that some of your data was corrupted and you should inspect it
+whether you would like to keep or move some of that data. Most likely the data was really corrupted
Review comment:
```suggestion
When you see such message, it means that some of your data was corrupted and you should inspect it to determine
whether you would like to keep or delete that data. Most likely the data was really corrupted
```
##########
File path: docs/apache-airflow/installation/upgrading.rst
##########
@@ -0,0 +1,77 @@
+ .. 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.
+
+Upgrading Airflow to a newer version
+------------------------------------
+
+When you are upgrading Airflow you should always upgrade the metadata DB as part of the upgrade
+process. This might happen automatically in some cases.
+For example when you are using :doc:`helm-chart:index` with post-upgrade hooks enabled, the database
+upgrade happens automatically after upgrade is completed. Similarly all Airflow-As-A-Service solutions
+run the upgrade automatically for you.
+
+However if you have your custom deployment based on virtualenv or Docker Containers, you need to run
+the DB upgrade manually as part of the upgrade process.
+
+In order to manually upgrade the database you should run ``airflow db upgrade`` command in your environment
+(either in your virtual environment or in your containers that gives you access to Airflow ``CLI``:
+:doc:`/usage-cli` and the database.
+
+Depending on the size of your database and the actual migration it might take quite some time to migrate it,
+so if you have long history and big database, it is recommended to make a copy of the database first and
+perform test migration to assess how long the migration will take. Typically "Major" upgrades might take
Review comment:
```suggestion
perform a test migration to assess how long the migration will take. Typically "Major" upgrades might take
```
##########
File path: airflow/www/templates/airflow/dags.html
##########
@@ -57,7 +57,8 @@
Airflow found incompatible data in the <code>{{ original_table_name }}</code> table in the
metadatabase, and has moved them to <code>{{ moved_table_name }}</code> during the database migration
to upgrade. Please inspect the moved data to decide whether you need to keep them, and manually drop
- the <code>{{ moved_table_name }}</code> table to dismiss this warning.
+ the <code>{{ moved_table_name }}</code> table to dismiss this warning.<p/>
+ Read more about it in <a href={{ get_docs_url("installing/upgrading.html") }}><b>Upgrading</b></a>
Review comment:
```suggestion
<p>Read more about it in <a href={{ get_docs_url("installing/upgrading.html") }}><b>Upgrading</b></a></p>
```
And then this should be a paragraph as well.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org