PHPackages                             israeldavidvm/database-knowledgeable - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. israeldavidvm/database-knowledgeable

ActiveLibrary[Database & ORM](/categories/database)

israeldavidvm/database-knowledgeable
====================================

v1.0(1y ago)012LGPL-3.0-or-laterPHPPHP >=5.4

Since Jan 21Pushed 1y ago1 watchersCompare

[ Source](https://github.com/israeldavidvm/database-knowledgeable)[ Packagist](https://packagist.org/packages/israeldavidvm/database-knowledgeable)[ RSS](/packages/israeldavidvm-database-knowledgeable/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (2)Versions (3)Used By (0)

**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [DatabaseKnowledgeable](#databaseknowledgeable)
    - [Licencia](#licencia)
    - [Caracteristicas ¿Qué te ofrece?](#caracteristicas-%C2%BFqu%C3%A9-te-ofrece)
    - [Features to implement / Caracteristicas a implementar](#features-to-implement--caracteristicas-a-implementar)
    - [Planning, Requirements Engineering and risk management / Planeacion, Ingenieria de Requerimientos y gestion del riesgo](#planning-requirements-engineering-and-risk-management--planeacion-ingenieria-de-requerimientos-y-gestion-del-riesgo)
    - [Software Design / Diseño de Software](#software-design--dise%C3%B1o-de-software)
        - [Perspectiva Estructural](#perspectiva-estructural)
            - [Vista Logica de la Arquitectura del software](#vista-logica-de-la-arquitectura-del-software)
        - [Perspectiva de comportamiento](#perspectiva-de-comportamiento)
    - [Documentacion](#documentacion)
        - [Convenciones usadas durante la docuemntacion](#convenciones-usadas-durante-la-docuemntacion)
        - [Soporte y Limitantes de los algoritmos](#soporte-y-limitantes-de-los-algoritmos)
            - [Algoritmos usados para determinar PK, Fk y demas atributos](#algoritmos-usados-para-determinar-pk-fk-y-demas-atributos)
                - [Convenciones de nombres usada para la identificacion de elementos](#convenciones-de-nombres-usada-para-la-identificacion-de-elementos)
                    - [Llaves Primarias](#llaves-primarias)
                    - [Ejemplos](#ejemplos)
                    - [Llaves Foraneas](#llaves-foraneas)
                    - [Ejemplos](#ejemplos-1)
        - [Uso](#uso)
            - [Requisitos](#requisitos)
                - [Instalacion](#instalacion)
                    - [Como usuario](#como-usuario)
                    - [Como biblioteca (Solo si quieres crear un programa que use la libreria)](#como-biblioteca-solo-si-quieres-crear-un-programa-que-use-la-libreria)
                - [Archivo .env](#archivo-env)
            - [Uso desde la interfaz de linea de comandos](#uso-desde-la-interfaz-de-linea-de-comandos)
                - [Si es incluido en un proyecto por medio de require con el global (composer global require israeldavidvm/database-knowledgeable)](#si-es-incluido-en-un-proyecto-por-medio-de-require-con-el-global-composer-global-require-israeldavidvmdatabase-knowledgeable)
                - [Si es incluido en un proyecto por medio de require sin el global (composer require israeldavidvm/database-knowledgeable)](#si-es-incluido-en-un-proyecto-por-medio-de-require-sin-el-global-composer-require-israeldavidvmdatabase-knowledgeable)
                - [Si es instalado por medio de install o se parte de la raiz del proyecto (composer install israeldavidvm/database-knowledgeable)](#si-es-instalado-por-medio-de-install-o-se-parte-de-la-raiz-del-proyecto-composer-install-israeldavidvmdatabase-knowledgeable)
            - [Uso como libreria](#uso-como-libreria)
        - [Make a donation. Your contribution will make a difference.](#make-a-donation-your-contribution-will-make-a-difference)
        - [Find me on:](#find-me-on)
    - [Technologies used / Tecnologias usadas](#technologies-used--tecnologias-usadas)

DatabaseKnowledgeable
=====================

[](#databaseknowledgeable)

[Readme version in English](./README-EN.md)

database-knowledgeable te permite obtener infomcacion basica de tu base de datos, generar informes y documentacion en formatos populares como markdown y mermaid. Mas concretamente

[![alt text](image.png)](image.png)

Licencia
--------

[](#licencia)

Este código tiene licencia bajo la licencia pública general de GNU versión 3.0 o posterior (LGPLV3+). Puede encontrar una copia completa de la licencia en

Caracteristicas ¿Qué te ofrece?
-------------------------------

[](#caracteristicas-qué-te-ofrece)

database-knowledgeable te permite obtener infomcacion basica de tu base de datos, generar informes y documentacion en formatos populares como markdown y mermaid. Mas concretamente

- Genera un informe markdown donde se enuncia cada tabla de tu base de datos, junto a un diagrama de mermaid, una breve explicacion de la tabla, sus campos, etc.
- Solo se tiene soporte para postgresql
- Interfaz de linea de comandos para acceder a las funciones de la libreria

Features to implement / Caracteristicas a implementar
-----------------------------------------------------

[](#features-to-implement--caracteristicas-a-implementar)

- Generacion de diagramas entidad relacion
- Generacion del modelo relacional
- Soporte a mas Sistemas Gestores de Base de Datos

Planning, Requirements Engineering and risk management / Planeacion, Ingenieria de Requerimientos y gestion del riesgo
----------------------------------------------------------------------------------------------------------------------

[](#planning-requirements-engineering-and-risk-management--planeacion-ingenieria-de-requerimientos-y-gestion-del-riesgo)

Estas secciones del proyecto se llevara por medio de un sitio en notion de forma que puedan ser facilmente accesibles por el personal no tecnico.

Solicita el link de acceso al personal autorizado

Software Design / Diseño de Software
------------------------------------

[](#software-design--diseño-de-software)

### Perspectiva Estructural

[](#perspectiva-estructural)

#### Vista Logica de la Arquitectura del software

[](#vista-logica-de-la-arquitectura-del-software)

### Perspectiva de comportamiento

[](#perspectiva-de-comportamiento)

Documentacion
-------------

[](#documentacion)

### Convenciones usadas durante la docuemntacion

[](#convenciones-usadas-durante-la-docuemntacion)

Convenciones de notacion para la gramatica:

Los <> se utilizan para rodear un simbolo no terminal

El ::= se utiliza para reglas de produccion

Los simbolos no terminales se expresan como una cadena o caracteres normales

El siguiente grupo de pares de simbolos, se deben utilizar junto a las expresiones de la siguiente forma: el primero en cada pareja se escribe como sufijo despues de la expresion y el segundo rodea la expresion.

El ? o \[\] indican que la expresion es opcional

El \* o {} indica que la expresion se repite 0 o mas veces

El + indica que la expresion se repite 1 o mas veces

Si se quiere usar uno de los caracteres anteriores se debe de anteceder \\ con

### Soporte y Limitantes de los algoritmos

[](#soporte-y-limitantes-de-los-algoritmos)

Lamentablemente algunos SGBD, dan soporte a los estadares de sql de forma diferente por lo que no existe una algoritmo universal que funcione perfectamente para todos los SGBD.

Esperamos en el futuro poder cambiar esto pero actualmente solo lo uso como herramienta personal y carezco de los recursos de tiempo para añadir dichas caracteristicas solo se proporcionara soporte comprobado a postgresql

#### Algoritmos usados para determinar PK, Fk y demas atributos

[](#algoritmos-usados-para-determinar-pk-fk-y-demas-atributos)

Si bien se pudo usar el conjunto de vistas de information\_schema para determinar algunas de las estructuras de la base de datos

Se descubrio que en postgresql se suelen generar joins aditivos, de manera que se utilizaran convenciones de nombres por rapidez. Esperamos mejorar dicha caracteristica en el futuro.

Ejemplo de falla del join aditivo

Por ejemplo si se quisiera saber si una columna en la information\_schema.key\_column\_usage es una PRIMARY KEY, FOREIGN KEY, etc, deberia usarse la consulta

```
SELECT kcu.column_name,kcu.table_name,tc.constraint_name,tc.constraint_type
            FROM
                information_schema.table_constraints tc
            JOIN
                information_schema.key_column_usage kcu
                    ON tc.constraint_name = kcu.constraint_name
```

Sin embargo si observamos detenidamente dichos resultados se ven afectados por un join aditivo

Para el caso particular de tener

```
SELECT column_name,table_name FROM information_schema.key_column_usage WHERE table_name ~ '^insight_taxonomy$'
```

que arroja resultados de esta forma

[![Information_schema.key_column_usage_where_table_name_insight_taxonomy](images/key_column_usage_where_table_name_insight_taxonomy.png)](images/key_column_usage_where_table_name_insight_taxonomy.png)

y un

```
SELECT tc.constraint_name
            FROM
                information_schema.table_constraints tc
            WHERE
				tc.constraint_name ~ '^taxonomy_id_fkey$'
```

que arroja resultados de esta forma

[![table_constraints_where_taxonomy_id_fkey](images/table_constraints_where_taxonomy_id_fkey.png)](images/table_constraints_where_taxonomy_id_fkey.png)

se tiene que el

```
SELECT kcu.column_name,kcu.table_name,tc.constraint_name,tc.constraint_type
            FROM
                information_schema.table_constraints tc
            JOIN
                information_schema.key_column_usage kcu
                    ON tc.constraint_name = kcu.constraint_name
            WHERE
				kcu.table_name ~ '^insight_taxonomy$'
```

genera los siguientes resultados que reflejan el join aditivo

[![aditiveJoin.png](images/aditiveJoin.png)](images/aditiveJoin.png)

##### Convenciones de nombres usada para la identificacion de elementos

[](#convenciones-de-nombres-usada-para-la-identificacion-de-elementos)

###### Llaves Primarias

[](#llaves-primarias)

Todo atributo de nombre id

###### Ejemplos

[](#ejemplos)

id

###### Llaves Foraneas

[](#llaves-foraneas)

Todo atributo que posee la siguiente forma

```
[_]_id

Donde [rol] sirve para identificar a la entidad en las relaciones recursivas

```

Coincide con la siguiente expresion regular

```
^[a-zA-Z0-9ñ]+(?:_[a-zA-Z0-9ñ]+)?_id$

```

###### Ejemplos

[](#ejemplos-1)

- user\_id
- taxonomy\_child\_id
- taxonomy\_parent\_id

### Uso

[](#uso)

#### Requisitos

[](#requisitos)

##### Instalacion

[](#instalacion)

###### Como usuario

[](#como-usuario)

composer install israeldavidvm/database-knowledgeable

composer global require israeldavidvm/database-knowledgeable

composer require israeldavidvm/database-knowledgeable

###### Como biblioteca (Solo si quieres crear un programa que use la libreria)

[](#como-biblioteca-solo-si-quieres-crear-un-programa-que-use-la-libreria)

composer require israeldavidvm/database-knowledgeable

##### Archivo .env

[](#archivo-env)

Establece una configuracion en el archivo .env. como la siguiente

```

DB_CONNECTION=pgsql
DB_HOST=127.0.0.1
DB_PORT=5432
DB_DATABASE=
DB_USERNAME=
DB_PASSWORD=

```

#### Uso desde la interfaz de linea de comandos

[](#uso-desde-la-interfaz-de-linea-de-comandos)

##### Si es incluido en un proyecto por medio de require con el global (composer global require israeldavidvm/database-knowledgeable)

[](#si-es-incluido-en-un-proyecto-por-medio-de-require-con-el-global-composer-global-require-israeldavidvmdatabase-knowledgeable)

Para poder usar el programa solo necesitaras un archivo .env con la configuracion de tu base de datos como se especifico anteriormente y ejecutar el comando

`~/.config/composer/vendor/bin/database-knowledgeable app:generateMarkdownDocumentation [ []] `

Arguments: depth Profundidad de los encabezados \[default: 1\] path La ruta al archivo .env. \[default: "./.env"\]

Options: -h, --help Display help for the given command. When no command is given display help for the list command --silent Do not output any message -q, --quiet Only errors are displayed. All other output is suppressed -V, --version Display this application version --ansi|--no-ansi Force (or disable --no-ansi) ANSI output -n, --no-interaction Do not ask any interactive question -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

##### Si es incluido en un proyecto por medio de require sin el global (composer require israeldavidvm/database-knowledgeable)

[](#si-es-incluido-en-un-proyecto-por-medio-de-require-sin-el-global-composer-require-israeldavidvmdatabase-knowledgeable)

Para poder usar el programa solo necesitaras un archivo .env con la configuracion de tu base de datos como se especifico anteriormente y ejecutar el comando

`./vendor/bin/database-knowledgeable app:generateMarkdownDocumentation [ []] `

Arguments: depth Profundidad de los encabezados \[default: 1\] path La ruta al archivo .env. \[default: "./.env"\]

Options: -h, --help Display help for the given command. When no command is given display help for the list command --silent Do not output any message -q, --quiet Only errors are displayed. All other output is suppressed -V, --version Display this application version --ansi|--no-ansi Force (or disable --no-ansi) ANSI output -n, --no-interaction Do not ask any interactive question -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

##### Si es instalado por medio de install o se parte de la raiz del proyecto (composer install israeldavidvm/database-knowledgeable)

[](#si-es-instalado-por-medio-de-install-o-se-parte-de-la-raiz-del-proyecto-composer-install-israeldavidvmdatabase-knowledgeable)

Para poder usar el programa solo necesitaras un archivo .env con la configuracion de tu base de datos como se especifico anteriormente y ejecutar el comando

`composer generateMarkdownDocumentation [ []] `

Arguments: depth Profundidad de los encabezados \[default: 1\] path La ruta al archivo .env. \[default: "./.env"\]

Options: -h, --help Display help for the given command. When no command is given display help for the list command --silent Do not output any message -q, --quiet Only errors are displayed. All other output is suppressed -V, --version Display this application version --ansi|--no-ansi Force (or disable --no-ansi) ANSI output -n, --no-interaction Do not ask any interactive question -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

#### Uso como libreria

[](#uso-como-libreria)

En un archivo php cualquiera llama a la biblioteca de la siguiente forma

```