the.moiza/postgresql-relationship-finder

Explore, analyze, and visualize relationships between database tables in PostgreSql

dev-master 2023-12-07 13:12 UTC

Requires

• php: >=7.2
• ext-fileinfo: *
• ext-mbstring: *
• ext-pdo: *
• ext-zip: *

Requires (Dev)

• phpunit/phpunit: ^9

MIT

• Moisés de Lima

README

Postgresql Relationship Finder is a tool for discovering and visualizing the relationships between database tables in PostgreSQL.

Table of Contents

• Features
• Getting Started
• Return Example
• Pre requisites
• Installation

Features

• Discover the relationships between tables using foreign keys.
• Easily navigate complex database schemas.
• Optimize SQL queries by understanding data relationships.

Getting Started

#!/usr/bin/php -q
<?php

require_once 'vendor/autoload.php';

use TheMoiza\PostgresqlRelationshipFinder\RelationshipFinder;

$RelationshipFinder = new RelationshipFinder;

echo $RelationshipFinder->find(
	$tableDown = ['public' => 'budget'],
	$tableTop = ['public' => 'users'],
	$connection = [
		"DB_HOST" => "127.0.0.1",
		"DB_PORT" => "5432",
		"DB_DATABASE" => "database",
		"DB_USERNAME" => "user",
		"DB_PASSWORD" => "pass",
		"DB_SCHEMA" => "public"
	]
);

Return Example

Execute the php file cli.php on the terminal.

$ php ./cli.php
··public.budget --> public.order --> public.cart --> public.users
··public.budget --> public.order --> public.users
··public.budget --> public.users

Pre requisites

Before you begin, ensure you have met the following requirements:

• PostgreSQL installed and configured.
• PHP for running the Postgresql Relationship Finder script.

Installation

1. By composer.

   composer require the.moiza/postgresql-relationship-finder

2. Clone this repository.

   git clone https://github.com/themoiza/postgresql-relationship-finder.git