YugabyteDB is a distributed, hybrid and multi-cloud open source community-driven database. It combines relational database capabilities with the horizontal scalability and resilience of cloud native architectures. YugabyteDB is like PostgreSQL re-imagined for a cloud native world.
Yugabyte exposes its storage engine DocsDB through two different APIs, each with its own set of capabilities and use cases.
- YSQL, the default API, is fully compatible with PostgreSQL query engine (it is reusing the code)
- YCQL is forked from the official Cassandra query engine. This API is not currently supported by Hackolade.
YugabyteDB supports two JSON data types: JSON and JSONB. They accept almost identical sets of values as input. The major practical difference is one of efficiency. The JSON data type stores an exact copy of the input text, which processing functions must reparse on each execution; while JSONB data is stored in a decomposed binary format that makes it slightly slower to input due to added conversion overhead, but significantly faster to process, since no reparsing is needed. JSONB also supports indexing, which can be a significant advantage.
To perform data modeling for YugabyteDB with Hackolade, you must first download the YugabyteDB plugin.
Hackolade was specially adapted to support the data modeling of YugabyteDB, including schemas, tables and views, indexes and constraints, plus the generation of DDL Create Table syntax.
In particular, Hackolade has the unique ability to model complex semi-structured objects stored in columns of the JSON and JSONB data types. We're not talking about functions that "flatten" JSON into standard columns, which runs the risk of inconsistencies, if not errors, when doing the Cartesian product of multiple complex data types. But about the storage of entire JSON documents. The reverse-engineering function, if it detects JSON documents, will sample records and infer the schema to supplement the DDL table definitions.
The data model in the picture below results from the data modeling of the flights booking demo:
Tablespaces, databases, and schemas
YugabyteDB being a geographically distributed cloud-native database, controlling how data should be spread across the cluster plays a very important role in achieving optimal performance. Such control is achieved through tablespaces which are entities that allow specifying the number of replicas for a set of tables or indexes, and also how each of these replicas should be distributed geographically across a set of cloud, regions, zones. Tablespaces allow to locate tables closer to their clients to decrease the latency.
A tablespace also allows to configure the Leader preference to gain even more control about the location of table and indecxes closer to their clients.
A database can contain one or multiple schemas and each schema belongs to only one database. Two schemas can have different objects that share the same name.
A schema is a namespace that contains named database objects such as tables, views, indexes, data types, functions, stored procedures and operators. Schemas allow you to organize database objects e.g., tables into logical groups to make them more manageable. YugabyteDB automatically creates a schema called public for every new database. Whatever object is created without specifying the schema name, YugabyteDB will place it into this public schema. In practice, it is better to refer to a table using a fully qualified name.
A single Hackolade model deals with a single database but can handle multiple schemas.
A table consists of rows and columns. The number and order of the columns is fixed, and each column has a name. Each column has a data type. The data type constrains the set of possible values that can be assigned to a column and assigns semantics to the data stored in the column so that it can be used for computations.
YugabyteDB shards data using the concept of tablet. A table can be created with explicit (manual) tablet configuration.
Hackolade does NOT currently support the maintenance, forward- or reverse-engineering of tablets metadata.
Unique, Primary, and Foreign Keys, plus Not Null, Check and Default constraints
Constraints in PostgreSQL are predefined rules and restrictions that are enforced in a single column or multiple columns, regarding the values allowed in the columns, to maintain the integrity, accuracy, and reliability of that column’s data. Constraints in YugabyteDB can be defined at the column level, where it is specified as part of the column definition and will be applied to that column only, or declared independently at the table level.
There are six main constraints that are commonly used in PostgreSQL: NOT NULL, UNIQUE, PRIMARY, FOREIGN, CHECK, and DEFAULT.
YugabyteDB organizes data automatically across nodes and splits user tables into multiple shards, called tablets using different possible strategies.
The goal of an index on a database table then is to reduce I/O. Properly indexing a YugabyteDB table is key to providing consistent, optimal performance. There are many things to consider when designing an index structure, but this goes beyond the scope of this document.
YugabyteDB provides indexes at tablespace level to further optimize data read queries.
Hackolade supports the most common types of YugabyteDB indexes.
YugabyteDB a rich set of data types available to users. A data type is an attribute that specifies the type of data that the object can hold: integer data, character data, monetary data, date and time data, binary strings, and so on.
Additionally, in JSON and JSONB columns, Hackolade supports the data modeling of JSON documents with standard JSON data types: string, number, object, array, boolean, and null. We also support geometries and geographies used in PostGIS.
User-defined data types, which are called Composite types in YugabyteDB, are based on the data types in YugabyteDB. User-defined data types can be used when several tables store the same domain of values in a column and must ensure that these columns have exactly the same data type, length, and NULLability.
A view is a virtual table whose contents are defined by a query. Like a table, a view consists of a set of named columns and rows of data. Unless indexed, a view does not exist as a stored set of data values in a database. The rows and columns of data come from tables referenced in the query defining the view and are produced dynamically when the view is referenced. A view acts as a filter on the underlying tables referenced in the view. The query that defines the view can be from one or more tables or from other views in the current or other databases.
Functions and Procedures
A function takes any number of arguments and returns a value from the function body. The function body can be any valid SQL expression as you would use, for example, in any select expression.A Stored Procedure is a routine invoked with a CALL statement. It may have input parameters, output parameters and parameters that are both input parameters and output parameters.
Hackolade dynamically generates the DDL script to create databases, tables, columns and their data types, indexes and constraints for the structure created with the application, as well as functions and procedures.
The script can also be exported to the file system via the menu Tools > Forward-Engineering, or via the Command-Line Interface.
If you store documents in JSON or JSONB columns, Hackolade allows for the schema design of those documents. However, the corresponding JSON structure is not forward-engineered in the DDL script, but is useful for developers, analysts and designers.
To apply to instance, you need USAGE privileges, and if that's not possible, then at least INSERT, UPDATE, DELETE, TRUNCATE, REFERENCES, TRIGGER, CREATE, CONNECT
The YugabyteDB instance can be hosted on-premises, or on virtualized machines in a private or public cloud. Details on how to connect Hackolade to YugabyteDB can be found on this page.
The Hackolade process for reverse-engineering of YugabyteDB databases includes the execution of statements to discover databases, tables, columns and their types, indexes and constraints. For JSON and JSONB columns, Hackolade performs statistical sampling of records followed by probabilistic inference of the JSON document schema.
Important: when reverse-engineering a YugabyteDB instance, non-privileged users can see the metadata of only their own objects depending on how Role based access control is setup on the instance, so to access others you need to be be granted the role USAGE. It more granularity is necessary, here are the full details:
1) SELECT privileges on all tables in `pg_catalog` schema (is default and included in PUBLIC role).
2) Schemas: CREATE or USAGE privilege.
3) Tables: SELECT or REFERENCES or TRIGGER privilege.
4) Columns: SELECT or REFERENCES privilege.
5) Views: SELECT or REFERENCES or TRIGGER privilege.
6) Function: EXECUTE privilege.
7) Domains: USAGE privilege.
More information is available here.