This package has been deprecated

Author message:

Moved to @cybertec/react-database-diagram

react-database-diagram
TypeScript icon, indicating that this package has built-in type declarations

0.1.12 • Public • Published

react-database-diagram

A react component to render nice database diagram using storm-react-diagrams

A diagram rendered by storm-react-diagram

Usage

import * as React from "react";
import * as ReactDOM from "react-dom";
 
import DatabaseDiagram, { IDatabaseTable } from "react-database-diagram";
 
const schema = [{
    columns: [
      { name: "a", type: "integer" },
      { name: "b", type: "integer" },
      { name: "c", type: "integer" }
    ],
    table_name: "t1",
    foreign_keys: [
      {
        toTable: "t2",
        toSchema: "public",
        toColumns: ["c"],
        fromColumns: ["c"]
      },
    ],
    primary_keys: ["a"],
    table_schema: "cypex_generated"
  },
  {
    columns: [{ name: "c", type: "integer" }],
    table_name: "t2",
    foreign_keys: [],
    table_schema: "cypex_generated"
  },] as IDatabaseTable;
 
  ReactDOM.render(<DatabaseDiagram schema={schema} />, document.body);
 

You can also check out the demo in the demo folder.

TODO

  • Add custom relations line
  • Add m:n display
  • Add tests

Dependents (0)

Package Sidebar

Install

npm i react-database-diagram

Weekly Downloads

10

Version

0.1.12

License

MIT

Unpacked Size

255 kB

Total Files

53

Last publish

Collaborators

  • agustin107