potiuk commented on code in PR #26217: URL: https://github.com/apache/airflow/pull/26217#discussion_r965358530
########## docs/apache-airflow/database-erd-ref.rst: ########## @@ -0,0 +1,23 @@ + .. 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. + +ERD Schema of the Database +'''''''''''''''''''''''''' + +Here is the current Database schema diagram. Review Comment: This is what I addressed In my warning proposals. And yes - I put exactly in the warning that the ERD diagram is really needed in this "narrow migration" window and should not be accessed directly. I think the intention of seeing the ERD diagram is also about the migration. When the migration is happening and you see "this column in this table is about to be added", you want to likely assess how big the table is and what will happen (when you are proffessional DB admin - and this ERD diagram is for those people). Those peopla are not likely we versed in the SQLAlchemy/Python code modelling the DB, but they will perfectly understand what it means when a foreign key and new column is going to be added to their table. And yeah - they likely can generate the ERD diagram using whatever tools they have at hand, but At least they will be able to see if their table is as expect before the migration - or in case they have any migraiton problems, to compare what "airflow" expects and what t hey "see". I think pretty much all our DB-related explanations are around migration and it should be the same for the ERD -diagram. This is mostly a migration helper. And I tried to explain this in the warning. -- 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]
