Feat: adding documentation to subtype relationship

Author: HansMarcus01

docs/create-diagram.md

@@ -71,6 +71,14 @@ You can define the following fields for a column:
 - Check constraint
 - Comment
 
+Although only Name, Datatype, Not null and Primary are visible from the settings panel, the other fields can be defined in the column edit panel that will open when clicking on the three dots icon.
+
+<ThemedImage
+    lightImageSrc={require("./img/light/more-options-fields.png").default}
+    darkImageSrc={require("./img/dark/more-options-fields.png").default}
+    alt="Edit fields"
+/>
+
 :::info
 
 If multiple primary keys are defined a composite primary key will be generated in the SQL output.
@@ -89,6 +97,12 @@ You can create attributes sequentially by pressing enter in the last field.
 
 :::
 
+:::info
+
+To define an attribute as primary key, select the checkbox with a key icon. If you want the attribute to be nullable or not nullable, select the checkbox with a question mark icon.
+
+:::
+
 ### Indexes
 
 You can define the following fields for an index:
@@ -99,7 +113,7 @@ You can define the following fields for an index:
 
 ## Relationships
 
-To create a relationship and define foreign keys, click and hold the blue dot on the primary key and drag it to the table with which you want to form the relationship. This will cause a new row to be automatically generated in the child table that will have the primary key information.
+To create a relationship and define foreign keys, long-press the blue dot on the primary key and drag it to the table you want to establish the relationship with. This will automatically generate the foreign key in the secondary table, which will contain the primary key information.
 
 <ThemedImage
     lightImageSrc={require("./img/light/create-relationship.gif").default}
@@ -111,8 +125,18 @@ The gif shows one of three possible notations selectable in the modeler; for eac
 
 <!--If at some point you realize that the keys are flipped you can swap them from the `Relationships` tab. Open the relationship you'd like to edit, click on the more button (three dots) next to the primary and forign columns, and then swap. -->!
 
+:::info
+
 To delete the relationship, simply double-click on the relationship and select the delete button or delete the auto-generated foreign key from the table.
 
+:::
+
+:::info
+
+To switch between identifying and non-identifying relationships, simply double-click, select the edit icon, or open the child table's configuration panel and modify the primary key attribute. If the foreign key is also part of the primary key, the relationship will be identifying; otherwise, it will be non-identifying.
+
+:::
+
 You can define the following fields for a relationship:
 
 - Name
@@ -123,7 +147,7 @@ You can define the following fields for a relationship:
 - Cardinality
     - Only available for One to one
         - (0,1)
-        - (0,1)
+        - (1,1)
     - Only available for One to Many
         - (0,*)
         - (1,*)
@@ -140,6 +164,25 @@ You can define the following fields for a relationship:
   - Set null
   - Set default
 
+### Supertypes and Subtypes Entities
+
+To create a relationship that uses this concept, you must first create a regular relationship, then go to its configuration panel and select the subtype in the relationship types section.
+
+When you select it, the relationship's notation will change, and a blue dot will appear next to it, allowing you to add more subtypes to your hierarchy model.
+
+<ThemedImage
+    lightImageSrc={require("./img/light/subtype-relationship.gif").default}
+    darkImageSrc={require("./img/dark/subtype-relationship.gif").default}
+    alt="Create a relationship"
+/>
+
+:::info
+
+To delete any of the subtypes involved in the relationship, simply delete the foreign key that was generated in the child table or access the relationship's configuration panel and delete the desired subtype.
+
+If you wish to delete the entire subtype relationship, simply select the delete relationship button.
+:::
+
 <FAQ header="How can I define Many to Many relationships?">
 
 In order to model Many to Many relationships you will need to use a join table.

docs/customizing-editor.md

@@ -22,7 +22,7 @@ You can customize editor settings in the `View` menu.
 | Field details | Disable showing pop ups when you hover over tables | Ctrl+Shift+F |
 | Reset view | Set the canvas cooridantes and zoom to default | Ctrl+R |
 | Show grid | Toggle the canvas grid | Ctrl+Shift+G |
-| Show cardinality | Toggle showing cardinality labels(1, n) for relationships | N/A |
+| Show cardinality | Toggle showing cardinality labels(1, *) for relationships | N/A |
 | Notation | Set notation style for relationships | N/A |
 | Show relationship labels | Toggle showing relationship names on the diagram | N/A |
 | Show debug coordinates | Display debug coordinate information | N/A |

docs/img/dark/more-options-fields.png

@@ -11,12 +11,12 @@ import FAQ from '@site/src/components/FAQ';
 Para comenzar, ve al [editor en línea](https://www.drawdb.app/editor). Si se carga un diagrama anterior, puedes ir a `Archivo > Nuevo` y elegir la opción de diagrama en blanco.
 
 <Flex>
-<ThemedImage 
+<ThemedImage
     lightImageSrc={require("./img/light/file-new.png").default}
     darkImageSrc={require("./img/dark/file-new.png").default}
     alt="Nuevo archivo"
 />
-<ThemedImage 
+<ThemedImage
     lightImageSrc={require("./img/light/create-blank-diagram.png").default}
     darkImageSrc={require("./img/dark/create-blank-diagram.png").default}
     alt="Crear un diagrama en blanco"
@@ -30,13 +30,16 @@ Puedes crear diagramas específicos de la base de datos o genéricos.
 - Los diagramas genéricos se pueden importar o exportar a cualquiera de los sabores de SQL compatibles; sin embargo, admiten un número menor de tipos.
 - Los diagramas específicos de la base de datos admiten todos los tipos de datos para la base de datos seleccionada y otras características específicas de la base de datos.
 
-Se admiten las siguientes bases de datos:
+Las siguientes bases de datos son compatibles:
 
 - MySQL
 - PostgreSQL
 - SQLite
 - MariaDB
 - MSSQL
+- Oracle
+
+Por el momento, la importación de diagramas SQL no está habilitada para Oracle Database.
 
 <ThemedImage
     lightImageSrc={require("./img/light/pick-db.png").default}
@@ -68,6 +71,14 @@ Puedes definir los siguientes campos para una columna:
 - Restricción de verificación
 - Comentario
 
+Aunque únicamente el Nombre, Tipo de dato, No nulo y Primaria son visibles desde el panel de configuración, los demás campos se pueden definir en el panel de edición de la columna, que se abrirá al hacer clic en el ícono de los tres puntos.
+
+<ThemedImage
+    lightImageSrc={require("./img/light/more-options-fields.png").default}
+    darkImageSrc={require("./img/dark/more-options-fields.png").default}
+    alt="Editar campos"
+/>
+
 :::info
 
 Si se definen varias claves primarias, se generará una clave primaria compuesta en la salida SQL.
@@ -80,6 +91,18 @@ La restricción de verificación se inyectará en la salida SQL tal como está.
 
 :::
 
+:::info
+
+Se pueden crear atributos secuencialmente presionando enter en el último campo.
+
+:::
+
+:::info
+
+Para definir un atributo como llave primaria, selecciona la casilla con un ícono de llave. Si deseas que el atributo sea nulo o no nulo, selecciona la casilla con un ícono de signo de interrogación.
+
+:::
+
 ### Índices
 
 Puedes definir los siguientes campos para un índice:
@@ -90,25 +113,49 @@ Puedes definir los siguientes campos para un índice:
 
 ## Relaciones
 
-Para crear relaciones y definir claves foráneas, haz clic y mantén presionado el punto azul en la columna de la clave foránea, luego arrástralo y suéltalo en la columna de la clave primaria. Esta acción sigue la lógica de `columna_inicio REFERENCIA columna_fin`, donde la columna desde la que arrastras se designará como la clave foránea, vinculándola a la clave primaria en la columna de destino.
+Para crear una relación y definir claves foráneas, mantenga pulsado el punto azul en la clave principal y arrástrelo a la tabla con la que desea establecer la relación. Esto generará automáticamente la llave foránea en la tabla hija que contendrá la información de la clave principal.
 
 <ThemedImage
     lightImageSrc={require("./img/light/create-relationship.gif").default}
     darkImageSrc={require("./img/dark/create-relationship.gif").default}
     alt="Crear una relación"
 />
 
-Por ejemplo, en la imagen de arriba, como `posts.user_id` es la clave foránea, comenzamos a arrastrar desde `user_id` a `users.id`.
+El gif muestra una de las tres posibles notaciones seleccionables en el modelador; para cada notación, la representación y algunas acciones pueden variar.
+
+<!-- Si en algún momento te das cuenta de que las claves están invertidas, puedes intercambiarlas desde la pestaña `Relaciones`. Abre la relación que deseas editar, haz clic en el botón de más (tres puntos) junto a las columnas primaria y foránea, y luego intercambia. -->
+
+:::info
+
+Para eliminar la relación, simplemente haga doble clic en la relación y seleccione el botón Eliminar o elimine la clave foránea generada automáticamente de la tabla.
+
+:::
+
+:::info
+
+Para alternar entre relaciones identificativas y no identificativas, basta con dar doble clic, seleccionar el ícono de edición o abrir directamente el panel de configuración de la tabla hija y modificar el atributo de llave primaria. Si la llave foránea también forma parte de la llave primaria, la relación será identificativa; en caso contrario, será no identificativa.
 
-Si en algún momento te das cuenta de que las claves están invertidas, puedes intercambiarlas desde la pestaña `Relaciones`. Abre la relación que deseas editar, haz clic en el botón de más (tres puntos) junto a las columnas primaria y foránea, y luego intercambia.
+:::
 
 Puedes definir los siguientes campos para una relación:
 
 - Nombre
-- Cardinalidad
+- Tipo de relación
   - Uno a uno
   - Uno a muchos
-  - Muchos a uno
+  - Subtipo
+  - Cardinalidad
+    - Solo disponible para Uno a uno
+      - (0,1)
+      - (1,1)
+    - Solo disponible para Uno a muchos
+      - (0,*)
+      - (1,*)
+- Restricción de subtipo (Solo disponible para relaciones de subtipo)
+  - Excluyente Total
+  - Excluyente Parcial
+  - Traslape Total
+  - Traslape Parcial
 - Acción al eliminar
 - Acción al actualizar
   - Sin acción
@@ -117,11 +164,30 @@ Puedes definir los siguientes campos para una relación:
   - Establecer nulo
   - Establecer por defecto
 
+### Entidades de Supertipos y Subtipos
+
+Para crear alguna relación que utilice este concepto, es necesario crear en primera instancia una relación comun y corriente para posteriormente ir a su panel de configuración y seleccionar en el apartado de tipos de relaciones el de subtipo.
+
+Al seleccionarlo, la notación de la relación cambiará y se generará un punto azul al lado de esta, el cual permitirá añadir más subtipos a tu modelo de jerarquía.
+
+<ThemedImage
+    lightImageSrc={require("./img/light/subtype-relationship.gif").default}
+    darkImageSrc={require("./img/dark/subtype-relationship.gif").default}
+    alt="Create a relationship"
+/>
+
+:::info
+
+Para eliminar cualquiera de los subtipos que participan en la relación, basta con eliminar la llave foranea que se genero en la tabla hija o bien acceder al panel de configuración de la relación y eliminar el subtipo que desees.
+
+En caso de que se desee eliminar toda la relación de subtipo, basta con seleccionar el botón de eliminar relación.
+
+:::
 <FAQ header="¿Cómo puedo definir relaciones de muchos a muchos?">
 
 Para modelar relaciones de muchos a muchos, deberás usar una tabla de unión.
 
-Una tabla de unión es una tercera tabla que contiene claves foráneas a las 2 tablas que deseas conectar. Además, puedes agregar cualquier otra columna específica de la relación a la tabla. Por ejemplo:
+Una tabla de unión es una tercera tabla que contiene claves foráneas a las dos tablas que deseas conectar. Además, puedes agregar cualquier otra columna específica de la relación a la tabla. Por ejemplo:
 
 <ThemedImage lightImageSrc={require("./img/light/many-to-many.png").default} darkImageSrc={require("./img/dark/many-to-many.png").default} alt="Elige una base de datos" />
 
@@ -130,9 +196,11 @@ Una tabla de unión es una tercera tabla que contiene claves foráneas a las 2 t
 ## Áreas temáticas
 
 Puedes agregar áreas temáticas desde la pestaña `Áreas temáticas` en la barra lateral o desde la barra de herramientas. Agrupan lógicamente las tablas en áreas temáticas para facilitar la navegación por el diagrama; tienen un propósito puramente visual y no se traducen en ninguna lógica SQL y no se reflejan en los scripts generados.
+Puedes agregar áreas temáticas desde la pestaña `Áreas temáticas` en la barra lateral o desde la barra de herramientas. Agrupan lógicamente las tablas en áreas temáticas para facilitar la navegación por el diagrama; tienen un propósito puramente visual y no se traducen en ninguna lógica SQL ni se reflejan en los scripts generados.
 
 ## Notas
 
+Puedes agregar notas desde la pestaña `Notas` en la barra lateral o desde la barra de herramientas. Puedes usar notas para capturar cualquier comentario adicional en el diagrama.
 Puedes agregar notas desde la pestaña `Notas` en la barra lateral o desde la barra de herramientas. Puedes usar notas para capturar cualquier comentario adicional en el diagrama.
 
 ## Tipos personalizados
@@ -141,7 +209,7 @@ Si el tipo de diagrama admite tipos personalizados, habrá una pestaña adiciona
 
 | **Base de datos** | **Comportamiento** |
 | --- | --- |
-| **MySQL/MariaDB** | Un JSON con la correspondiente verificación de validación de JSON |
+| **MySQL/MariaDB** | Un JSON con la correspondiente validación de JSON |
 | **PostgreSQL** | Un tipo compuesto |
 | **SQLite** | BLOB |
 | **MSSQL** | Un alias de tipo para el primer campo |
@@ -151,3 +219,4 @@ Al agregar un nuevo tipo, se agregará a la lista de tipos que puedes elegir al
 ## Enums (PostgreSQL)
 
 Si el diagrama es para PostgreSQL, habrá una pestaña adicional de `Enums` en la barra lateral donde puedes definir valores de enumeración. Al agregar una nueva enumeración, se agregará a la lista de tipos que puedes elegir al editar una columna.
+Si el diagrama es para PostgreSQL, habrá una pestaña adicional de `Enums` en la barra lateral donde puedes definir valores de enumeración. Al agregar una nueva enumeración, se agregará a la lista de tipos que puedes elegir al editar una columna.

docs/img/dark/subtype-relationship.gif

@@ -22,7 +22,8 @@ Puedes personalizar la configuración del editor en el menú `Ver`.
 | Detalles del campo | Desactivar la aparición de ventanas emergentes al pasar el ratón por encima de las tablas | Ctrl+Shift+F |
 | Restablecer vista | Establecer las coordenadas y el zoom del lienzo a los valores predeterminados | Ctrl+R |
 | Mostrar cuadrícula | Alternar la cuadrícula del lienzo | Ctrl+Shift+G |
-| Mostrar cardinalidad | Alternar la visualización de las etiquetas de cardinalidad (1, n) para las relaciones | N/A |
+| Mostrar cardinalidad | Alternar la visualización de las etiquetas de cardinalidad (1, *) para las relaciones | N/A |
+| Notación | Establecer el estilo de notación para las relaciones | N/A |
 | Mostrar etiquetas de relación | Alternar la visualización de los nombres de las relaciones en el diagrama | N/A |
 | Mostrar coordenadas de depuración | Mostrar información de coordenadas de depuración | N/A |
 | Tema | Establecer el tema del editor en oscuro o claro | N/A |