Refactor relations Help pages in sdatabase/

Change-Id: I6bb25934bc3f1443fbd5aa9806936a3628c03454 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/111681 Tested-by: Jenkins Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
author: Olivier Hallot <olivier.hallot@libreoffice.org> 2021-02-27 11:56:08 -0300
committer: Olivier Hallot <olivier.hallot@libreoffice.org> 2021-02-27 15:59:30 +0100
commit: 6c9b69b325847e9211679bcfee453ab25612feee (patch)
tree: e1d2553981683457dfb3702232787d72a591244e /source/text/sdatabase
parent: 59cb964358c41f4353ba8af63bdccec6edf84ce9 (diff)
4 files changed, 137 insertions, 2 deletions
diff --git a/source/text/sdatabase/05000000.xhp b/source/text/sdatabase/05000000.xhp
index a68f9ee4b7..d42d385533 100644
--- a/source/text/sdatabase/05000000.xhp
+++ b/source/text/sdatabase/05000000.xhp
@@ -36,7 +36,7 @@
 <embed href="text/shared/01/05340400.xhp#data_sources"/>
 <embed href="text/shared/02/12100200.xhp#findrecord"/>
 <h2 id="hd_id3149095"><link href="text/shared/main0212.xhp" name="Sort and Filter Data">Sort and Filter Data</link></h2>
-<h2 id="hd_id3154288"><link href="text/shared/explorer/database/05020000.xhp" name="Relations, Primary and External Key">Relations, Primary and External Key</link></h2>
+<h2 id="hd_id3154288"><link href="text/sdatabase/05020000.xhp" name="Relations, Primary and External Key">Relations, Primary and External Key</link></h2>
 <embed href="text/sdatabase/05000001.xhp#context"/>
 </body>
 </helpdocument>
diff --git a/source/text/sdatabase/05000001.xhp b/source/text/sdatabase/05000001.xhp
index 6855b58153..130e25358f 100644
--- a/source/text/sdatabase/05000001.xhp
+++ b/source/text/sdatabase/05000001.xhp
@@ -38,7 +38,7 @@
 <paragraph role="paragraph" id="par_id3145382" xml-lang="en-US">Depending on the database system used, you will find the following entries on the context menus:</paragraph>
 <embed href="text/shared/00/00000010.xhp#open"/>
 <paragraph role="paragraph" id="par_id3166461" xml-lang="en-US">If a <link href="text/shared/01/05340400.xhp" name="table is open">table is open</link>, there are several functions available to edit the data.</paragraph>
-<embed href="text/shared/explorer/database/05020000.xhp#relations"/>
+<embed href="text/sdatabase/05020000.xhp#relations"/>
 <embed href="text/shared/00/00000010.xhp#verknuepfungerstellen"/>
 </body>
 </helpdocument>
diff --git a/source/text/sdatabase/05020000.xhp b/source/text/sdatabase/05020000.xhp
new file mode 100644
index 0000000000..d510070b08
--- /dev/null
+++ b/source/text/sdatabase/05020000.xhp
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   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 .
+ -->
+
+
+<meta>
+<topic id="textsharedexplorerdatabase05020000xml" indexer="include">
+<title id="tit" xml-lang="en-US">Relations</title>
+<filename>/text/sdatabase/05020000.xhp</filename>
+</topic>
+</meta>
+<body>
+<section id="relations">
+<bookmark xml-lang="en-US" branch="hid/DBACCESS_HID_CTL_RELATIONTAB" id="bm_id3153345" localize="false"/>
+<h1 id="hd_id3153323"><link href="text/sdatabase/05020000.xhp" name="Relations">Relations</link></h1>
+<bookmark xml-lang="en-US" branch="index" id="bm_id3146957"><bookmark_value>relational databases (Base)</bookmark_value>
+</bookmark><comment>mw added "(Base)"</comment>
+<paragraph role="paragraph" id="par_id3146957" xml-lang="en-US">This command opens the <emph>Relation Design </emph>window, which allows you to define relationships between various database tables.</paragraph>
+</section>
+<paragraph role="paragraph" id="par_id3154823" xml-lang="en-US"><ahelp hid="HID_CTL_RELATIONTAB">Here you can link together tables from the current database through common data fields.</ahelp> Click the <emph>New Relation</emph> icon to create the relationships, or simply drag-and-drop with the mouse.</paragraph>
+<section id="howtoget">
+<embed href="text/shared/00/00000450.xhp#relationen"/>
+</section>
+<note id="par_id3145316">This function is only available if you are working with a relational database.</note>
+<paragraph role="paragraph" id="par_id3149235" xml-lang="en-US">When you choose <emph>Tools - Relationships</emph>, a window opens in which all the existing relationships between the tables of the current database are shown. If no relationships have been defined, or if you want to relate other tables of the database to each other, then click on the <emph>Add Tables</emph> icon. The <link href="text/shared/02/14020100.xhp" name="Add Tables">Add Tables</link> dialog opens in which you can select the tables with which to create a relation.</paragraph>
+<embed href="text/shared/00/00000450.xhp#sytabelle"/>
+<note id="par_id3152812">If the <emph>Relation Design</emph> window is open, the selected tables cannot be modified, even in Table Design mode. This ensures that tables are not changed while the relations are being created.</note>
+<paragraph role="paragraph" id="par_id3150541" xml-lang="en-US">The selected tables are shown in the top area of the relation design view. You can close a table window through the context menu or with the Delete key.</paragraph>
+<embed href="text/sdatabase/02010100.xhp#change_display"/>
+<bookmark xml-lang="en-US" branch="index" id="bm_id3148922"><bookmark_value>primary keys;inserting (Base)</bookmark_value>
+<bookmark_value>keys;primary keys (Base)</bookmark_value>
+<bookmark_value>external keys (Base)</bookmark_value>
+</bookmark><comment>mw added "(Base)" to all entries</comment>
+<h2 id="hd_id3148922">Primary key and foreign keys</h2>
+<paragraph role="paragraph" id="par_id3149168" xml-lang="en-US">If you want to define a relation among the various tables, you should enter a <link href="text/shared/00/00000005.xhp#primaerschluessel" name="primary key">primary key</link> that uniquely identifies a data field of an existing table. You can refer to the primary key from other tables to access the data of this table. All data fields referring to this primary key will be identified as a foreign key.</paragraph>
+<paragraph role="paragraph" id="par_id3147085" xml-lang="en-US">All data fields referring to a primary key will be identified in the table window by a small key symbol.</paragraph>
+<h2 id="hd_id3153193">Define relations</h2>
+<bookmark xml-lang="en-US" branch="index" id="bm_id3155430"><bookmark_value>relations; creating and deleting (Base)</bookmark_value>
+</bookmark><comment>mw added "(Base)"</comment>
+<paragraph role="paragraph" id="par_id3155430" xml-lang="en-US">All existing relations are shown in the relations windows by a line that connects the primary and foreign key fields. You can add a relation by using drag-and-drop to drop the field of one table onto the field of the other table. A relation is removed again by selecting it and pressing the Delete key.</paragraph>
+<paragraph role="paragraph" id="par_id3149984" xml-lang="en-US">Alternatively, you can also click the <emph>New Relation</emph> icon in the top area of the relation field and define the relation between two tables in the <link href="text/sdatabase/05020100.xhp" name="Relations"><emph>Relations</emph></link> dialog.</paragraph>
+<embed href="text/shared/00/00000450.xhp#SyRelationen"/>
+<warning id="par_id3153093">If you use $[officename] as the front-end for a relational database, the creation and deletion of relationships is not placed in an intermediate memory by $[officename], but is forwarded directly to the database.</warning>
+<paragraph role="paragraph" id="par_id3155856" xml-lang="en-US">By double-clicking a connection line, you can assign certain properties to the relation. The <emph>Relations </emph>dialog opens.</paragraph>
+</body>
+</helpdocument>
diff --git a/source/text/sdatabase/05020100.xhp b/source/text/sdatabase/05020100.xhp
new file mode 100644
index 0000000000..00e3422f9e
--- /dev/null
+++ b/source/text/sdatabase/05020100.xhp
@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   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 .
+ -->
+<helpdocument version="1.0">
+<meta>
+<topic id="textsharedexplorerdatabase05020100xml" indexer="exclude" status="PUBLISH">
+<title id="tit" xml-lang="en-US">Relations</title>
+<filename>/text/sdatabase/05020100.xhp</filename>
+</topic>
+<history>
+<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
+</history>
+</meta>
+<body>
+<bookmark xml-lang="en-US" branch="hid/.uno:DBAddRelation" id="bm_id3155150" localize="false"/>
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/relationdialog/RelationDialog" id="bm_id3155151" localize="false"/>
+<bookmark xml-lang="en-US" branch="index" id="bm_id3150499"><bookmark_value>relations; properties (Base)</bookmark_value>
+<bookmark_value>key fields for relations (Base)</bookmark_value>
+<bookmark_value>cascading update (Base)</bookmark_value>
+</bookmark><comment>mw added "(Base)" to all entries</comment>
+<h1 id="hd_id3150445">Relations</h1>
+<paragraph role="paragraph" id="par_id3150499" xml-lang="en-US"><ahelp hid=".uno:DBAddRelation">Allows you to define and edit a relation between two tables.</ahelp></paragraph>
+<section id="howtoget">
+  <embed href="text/shared/00/00000450.xhp#relationen"/>
+</section>
+<note id="par_id3155136">The update and delete options are only available if they are supported by the database used.</note>
+<h2 id="hd_id3155341">Tables</h2>
+<paragraph role="paragraph" id="par_id3153880" xml-lang="en-US"><ahelp hid="dbaccess/ui/relationdialog/table2" visibility="hidden">This is where the two related tables are listed.</ahelp> If you create a new relation, you can select one table from each of the combo boxes in the top part of the dialog.</paragraph>
+<paragraph role="paragraph" id="par_id3154047" xml-lang="en-US">If you opened the <emph>Relations</emph> dialog for an existing relation by double-clicking the connection lines in the Relation window, then the tables involved in the relation cannot be modified.</paragraph>
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/joindialog/relations" id="bm_id3153716" localize="false"/>
+<h2 id="hd_id3153822">Key fields</h2>
+<paragraph role="paragraph" id="par_id3159157" xml-lang="en-US"><ahelp hid="dbaccess/ui/joindialog/relations">Defines the key fields for the relation.</ahelp></paragraph>
+<bookmark xml-lang="en-US" branch="hid/dbaccess/ui/relationdialog/relations" id="bm_id3153543" localize="false"/>
+<paragraph role="paragraph" id="par_id3149235" xml-lang="en-US"><ahelp hid="dbaccess/ui/relationdialog/table2">The names of the tables selected for the link appear here as column names.</ahelp> If you click a field, you can use the arrow buttons to select a field from the table. Each relation is written in a row.</paragraph>
+<h2 id="hd_id3145609">Update options</h2>
+<paragraph role="paragraph" id="par_id3153061" xml-lang="en-US">Here you can select options that take effect when there are changes to a primary key field.</paragraph>
+<h3 id="hd_id3149046">No action</h3>
+<paragraph role="paragraph" id="par_id3152360" xml-lang="en-US"><ahelp hid="dbaccess/ui/relationdialog/addaction">Specifies that any change made to a primary key does not affect other external key fields.</ahelp></paragraph>
+<h3 id="hd_id3148664">Updating cascade</h3>
+<paragraph role="paragraph" id="par_id3154073" xml-lang="en-US"><ahelp hid="dbaccess/ui/relationdialog/addcascade">Updates all the external key fields if the value of the corresponding primary key has been modified (Cascading Update).</ahelp></paragraph>
+<h3 id="hd_id3145171">Set null</h3>
+<paragraph role="paragraph" id="par_id3154123" xml-lang="en-US"><ahelp hid="dbaccess/ui/relationdialog/addnull"> If the corresponding primary key has been modified, use this option to set the "IS NULL" value to all external key fields. IS NULL means that the field is empty.</ahelp></paragraph>
+<h3 id="hd_id3150448">Set default</h3>
+<paragraph role="paragraph" id="par_id3151041" xml-lang="en-US"><ahelp hid="dbaccess/ui/relationdialog/adddefault"> If the corresponding primary key has been modified, use this option to set a default value to all external key fields.</ahelp> During the creation of the corresponding table, the default value of an external key field will be defined when you assign the field properties.</paragraph>
+<h2 id="hd_id3125863">Delete options</h2>
+<paragraph role="paragraph" id="par_id3153193" xml-lang="en-US">Here you can select options that take effect when a primary key field is deleted.</paragraph>
+<h3 id="hd_id3159252">No action</h3>
+<paragraph role="paragraph" id="par_id3145785" xml-lang="en-US"><ahelp hid="dbaccess/ui/relationdialog/delaction">Specifies that the deletion of a primary key will not have any effect on other external key fields.</ahelp></paragraph>
+<h3 id="hd_id3154146">Delete cascade</h3>
+<paragraph role="paragraph" id="par_id3155309" xml-lang="en-US"><ahelp hid="dbaccess/ui/relationdialog/delcascade">Specifies that all external key fields will be deleted if you delete the corresponding primary key field.</ahelp></paragraph>
+<warning id="par_id3153140">When you delete a primary key field with the<emph> Delete cascade </emph>option, all records from other tables that have this key as their foreign key are also deleted. Use this option with great care; it is possible that a major portion of the database can be deleted.</warning>
+<h3 id="hd_id3152596">Set null</h3>
+<paragraph role="paragraph" id="par_id3153363" xml-lang="en-US"><ahelp hid="dbaccess/ui/relationdialog/delnull">If you delete the corresponding primary key, the "IS NULL" value will be assigned to all external key fields.</ahelp></paragraph>
+<h3 id="hd_id3145272">Set Default</h3>
+<paragraph role="paragraph" id="par_id3154320" xml-lang="en-US"><ahelp hid="dbaccess/ui/relationdialog/deldefault">If you delete the corresponding primary key, a set value will be set to all external key fields.</ahelp></paragraph>
+</body>
+</helpdocument>
author	Olivier Hallot <olivier.hallot@libreoffice.org>	2021-02-27 11:56:08 -0300
committer	Olivier Hallot <olivier.hallot@libreoffice.org>	2021-02-27 15:59:30 +0100
commit	6c9b69b325847e9211679bcfee453ab25612feee (patch)
tree	e1d2553981683457dfb3702232787d72a591244e /source/text/sdatabase
parent	59cb964358c41f4353ba8af63bdccec6edf84ce9 (diff)