Table of contents

• Welcome to Hackolade Studio
  • Vision
    • Challenges in data-driven org transformation
    • Solution overview
    • Data modeling
    • Why legacy and SaaS data modeling architectures fall short...
  • Getting started
    • System requirements
    • Installation
      • Security-first browser deployment
      • Windows
      • Mac
      • Linux
      • Deployment policy
      • Docker container
      • Bastion instance for Hackolade Studio
      • DevOps CI/CD architecture
    • Software registration
      • Old Software Validation dialog
    • Network proxy
    • Editions
    • Getting help
    • Sample models
    • License agreement
      • Exhibit A - Open Source components/libraries
    • Privacy policy
  • Tutorial
    • What is a data model?
    • Overview of JSON and JSON Schema
    • Query-driven data modeling based on access patterns
    • Create your first data model
    • Add nested objects and arrays
    • Add a choice, conditional, or pattern field
    • Add relationships
    • Import or reverse-engineer
    • Export or forward-engineer
    • Generate documentation and pictures
    • Create model for graph databases
    • Create a REST API model
    • Leverage a Polyglot data model
    • Pragmatic guide to a data modeling strategy
      • Conceptual modeling with Polyglot
      • Logical modeling with Polyglot
      • Embedding nested objects within parent entities
      • Referencing separate entities with foreign key relationships
      • Extended referencing hybrid with selective duplication
      • Derive from polyglot vs external reference
      • Design a hierarchical schema from a normalized Polyglot model
      • Convert model into a Polyglot in another repository
      • How to organize models
  • How-to guides
    • Define composite key constraints
    • Configure custom properties
    • Integrate the CLI with DevOps CI/CD pipelines
    • Add reusable definitions
      • Remote references
    • Naming Conventions use cases
    • Technical names in Polyglot models
      • Choosing a naming strategy
      • Handling of technical names during Impact Analysis
      • Handling when converting to a Polyglot model
      • Making the Polyglot model the source-of-truth for technical names
      • Handling technical names during convert and merge to an existing Polyglot
    • Model compare and merge use cases
      • Compare a baseline model with schema in prod
      • Convert merged changes into the parent polyglot model
    • Recreate broken reference link to a Polyglot model
    • Pre-populate new entities using snippets
    • Pre-populate properties with default values
    • Inheritance in Polyglot models
    • Best practices for collaboration and change management
    • Oracle 23ai and 26ai Duality Views
    • Union types in Avro
• Hackolade Model Hub
  • Overview
  • Model Hub solution architecture
  • Model Hub technical architecture
  • Browser configuration
  • Hub user interface
  • Hub FAQs
  • Hub deployment
    • Model Hub prerequisites
    • AWS or Azure stack deployment
    • OCI stack deployment
    • Parameters to connect front-end and back-end
  • Hub administration
    • Git repo configuration
      • GitHub repo setup
      • GitLab repo setup
      • Bitbucket Cloud repo setup
      • Bitbucket Data Center repo setup
      • Azure DevOps repo setup
    • Model Hub user management
    • OCI monitoring of Model Hub
    • Autonomous JSON database storage
• Data modeling and the AI lifecycle
• SQL and NoSQL databases, APIs, and storage formats
  • Polyglot Data Model
  • JSON Schema
  • Couchbase
  • DynamoDB
  • MongoDB
  • Download additional target plugins
    • Avro schema
    • BigQuery
    • Cassandra
    • CockroachDB
    • Confluent Schema Registry
    • Cosmos DB SQL & MongoDB APIs
    • Cosmos DB Gremlin
    • Couchbase with scopes and collections
    • Db2
    • Delta Lake on Databricks
    • DocumentDB
    • Elasticsearch
    • EventBridge
    • Event Hubs Azure Schema Registry
    • Firebase
    • Firestore
    • Glue Data Catalog
    • GraphQL
    • HBase
    • Hive
    • JanusGraph
    • MariaDB
    • MarkLogic
    • MySQL
    • Neo4j
    • Neptune Gremlin
    • OpenAPI
    • Oracle
    • Parquet schema
    • PostgreSQL
    • Protobuf
    • Pulsar Schema Registry
    • Redshift
    • ScyllaDB
    • Snowflake
    • SQL Server
    • Swagger API
    • Synapse
    • Teradata
    • TinkerPop
    • YugabyteDB
• Concepts
  • Schema design in a schemaless world
  • Benefits of data modeling apply to NoSQL and Agile
  • ER diagrams and cardinality
  • JSON Schema Tree view
  • Attributes
  • Relationships and denormalization
  • Conceptual to Logical with Polyglot relationships
  • Logical to Physical with Polyglot Relationships
  • Schema versioning
  • Team collaboration
  • Model versioning
  • Polyglot Data Modeling
  • Data modeling techniques
• Overview of user interface
  • Welcome page
  • Workspace
    • Title bar
    • Context bar
    • Menu bar
      • Default paths and file picker behavior
    • Toolbar
    • Object browser pane
    • Diagram objects pane
    • Central pane
    • Properties pane
    • UI customization
  • JSON Schema Editor
  • Manipulating shapes
    • Containers in ER diagram
    • Entity boxes in ER diagram
    • Attributes in entity boxes
    • Relationship lines in ER diagram
    • Associative entities for many-to-many relationships
    • Attribute boxes in hierarchical schema view
    • Choices
    • Read-only views
      • Generate SQL views from a SELECT AS statement
    • Diagram Views
    • Graph shapes
    • Colors and font styles
    • Symbols
  • Show model diff
  • Compare and merge models
  • Delta model and ALTER script
  • Generate documentation
  • Print a diagram
  • Shortcut keys
  • Re-usable objects definitions
  • User-defined custom properties
  • Command Line Interface
  • Naming conventions
  • Glossaries of business terms
  • Lineage capture
  • Suggest denormalization of a SQL schema
  • Infer Primary Keys and Foreign Key Relationships
  • Model-Driven API Generation
  • Generate mock data for testing
  • Verify Data Model
  • Governance Platforms Integration
    • Collibra Data Dictionary integration
      • Connection and authentication
      • Non-Ultimate edition integration
      • Reverse-engineer existing Collibra assets
    • DataHub
  • Bizzdesign EA integration
  • MongoDB Field-Level Encryption
• Repository
  • Concepts
  • Authentication
  • Connect to a repository hub
    • GitHub
    • Bitbucket Cloud
    • Bitbucket Data Center
    • Azure DevOps Repos
    • GitLab
    • Configure CORS headers
  • Share model link URL
  • Working directly with a remote repo
    • Open model from Git repo
    • Save model to Git repo
    • Solve conflicts
    • Submit for review
    • Review change requests
  • Working with a locally-cloned repo
    • Pre-requisites
    • Clone a remote repository
    • Open a local repository
    • Explore repository
      • Explore files
      • Explore history
      • Explore tags
      • Explore stashed changes
    • Checkout a branch
    • Commit local changes
    • Pull remote commits
    • Push local commits
    • Solve conflicts
    • Submit for review
    • Review change requests
    • Branch protection
    • Working with forks
    • Git subtree
    • Other actions
    • Jira integration
    • Questions & Answers
• Quick start guide
  • Create a new model from scratch
    • Forward-Engineering
      • JSON Document
      • YAML file
      • JSON Schema
      • YAML Schema
      • Excel file
      • API Model
      • dbt schema models
      • ArchiMate application data objects
      • Target-specific
        • Avro schema
        • BigQuery DDL
        • Cassandra CQL
        • CockroachDB DDL
        • Cosmos DB SQL API scripts
        • Cosmos DB Gremlin script
        • Couchbase scripts
        • Db2 DDL
        • Delta Lake scripts
        • DocumentDB script
        • DynamoDB scripts
        • Elasticsearch mappings
        • EventBridge
        • Ottoman Schema
        • Firebase (TBA)
        • Firestore (TBA)
        • Glue Data Catalog
        • HBase
        • Hive HQL
        • JanusGraph Gremlin
        • MariaDB DDL
        • MarkLogic
        • MongoDB scripts
        • Mongoose Schema
        • MySQL DDL
        • Neo4j Cypher
        • Neptune with Gremlin API
        • OpenAPI file
        • Oracle DDL
        • Parquet schema
        • PostgreSQL DDL
        • Protobuf schema
        • Redshift DDL
        • ScyllaDB CQL
        • Snowflake DDL
        • SQL Server DDL
        • Synapse DDL
        • Swagger file
        • Teradata DDL
        • TinkerPop Gremlin
  • Reverse-engineering
    • JSON document
    • YAML file
    • JSON Schema
    • YAML Schema
    • SQL DDL
    • Diagrams
      • GenAI-created Mermaid ER diagram
    • Excel template
    • PowerDesigner
      • Migrate external shortcuts
      • Migrate advanced physical options
    • XSD (XML Schema Definition)
      • From erwin
      • From ER/Studio
      • From PowerDesigner
      • From IBM InfoSphere
      • From Sparx Enterprise Architect
    • MongoDB Relational Migrator
    • Target-specific
      • Avro file or schema
      • Connect to a BigQuery instance
      • Connect to a Cassandra instance
        • Username/password
        • LDAP
        • SSH
        • Astra
      • Connect to a CockroachDB instance
        • SSL
        • SSH
      • Connect to Confluent Schema Registry
        • SSL
        • JKS Trust Store
        • Cookie name-value pair
      • Connect to a Cosmos DB instance
        • Core API
          • Local instance
          • Azure instance
        • MongoDB API
          • Local instance
          • Azure instance
        • Gremlin API
          • Azure instance
      • Connect to a Couchbase instance
      • Connect to a Db2 instance
      • Connect to a Delta Lake instance
      • Connect to a DocumentDB instance
      • Connect to a DynamoDB instance
        • Local instance
        • AWS instance
      • Connect to an Elasticsearch instance
      • Connect to EventBridge Schema Registry
      • Connect to a Firebase instance (TBA)
      • Connect to a Firestore instance (TBA)
      • Connect to an AWS Glue Data Catalog
      • Connect to an HBase instance
        • Kerberos
      • Connect to a Hive instance
        • None (Plain SASL)
        • NoSASL
        • LDAP
        • Kerberos
        • Azure HDInsight
      • Connect to a JanusGraph instance
        • SSL
        • SSH
      • Connect to a MariaDB instance
        • SSL
        • SSH
        • SkySQL
      • Connect to a MarkLogic instance
      • Connect to a MongoDB instance
        • Username/password
        • MongoDB Atlas
        • Azure Cosmos DB vCore
        • SSL
        • X.509
        • LDAP
        • Kerberos
        • SSH
        • AWS IAM
      • Connect to a MySQL instance
        • SSL
        • SSH
      • Connect to a Neo4j instance
        • SSL
        • SSH
      • Connect to a Neptune instance
      • OpenAPI file
      • Connect to an Oracle instance
        • SSH
      • Parquet schema
      • Connect to a PostgreSQL instance
        • SSL
        • SSH
        • Amazon RDS or Aurora
      • Protobuf schema file or registry
      • Connect to Amazon Redshift
      • Connect to a ScyllaDB instance
        • Username/password
        • LDAP
      • Connect to a Snowflake instance
        • Snowflake authentication
        • Native SSO (Okta only)
        • Identity Provider SSO (external browser)
        • Key-pair authentication
      • Connect to a SQL Server instance
        • SQL Server authentication
        • Windows authentication
        • Entra ID authentication
        • SSL
        • SSH
      • Connect to Synapse
        • Entra ID authentication
      • Swagger file
      • Connect to a Teradata instance
        • SSL
        • SSH
      • Connect to a TinkerPop instance
      • Connect to YugabyteDB
        • SSL
        • SSH
• FAQ and troubleshooting
  • How to get help and support?
  • Tips and tricks
  • COTS Security Clarification
  • Product Security Package
  • Security concerns
  • Vulnerabilities
  • Installation FAQ
    • Professional Edition deployment options
    • Moving to another computer
    • Windows access denied error during upgrade
    • Mac EPERM: operation not permitted
    • Error message: spawn UNKNOWN
    • Error: spawn git ENOENT
    • Error: EBUSY: resource busy or locked
  • Licensing FAQ
    • Which license should I choose?
    • Concurrent license key behavior
    • Transfer a license to a new computer
    • Managing multiple license keys and seats
    • Why is there no admin screen to release seats?
  • Data modeling concepts FAQ
    • What is polymorphism?
    • What's a pattern field?
    • Regular expression
    • What is a choice?
  • Implementation and deployment guide
    • Deployment schedule
    • Roles and Responsibilities
    • Risk Management
    • Lessons Learned
    • Change Management
    • Governance
    • Knowledge Transfer and Training
  • MongoDB FAQ
    • MongoDB error not master and slaveOk=false
    • Why is MongoDB timestamp is disabled?
    • Authentication Failed Error Message
    • MongoError: Authentication failed
    • SSH-RSA key rejected with message "no mutual signature algorithm"
    • How to set uniqueness for a field in MongoDB
  • Cassandra FAQ
    • Server timeout during read query at consistency LOCAL_ONE
  • Couchbase FAQ
    • Access issues when doing reverse-engineering of Couchbase
    • Document types for Couchbase are not discovered as expected
    • Generate Schema Error during Couchbase reverse-engineering
  • Snowflake FAQ
    • SQL compilation error:Sequence used as a default value in table... was not found or could not be accessed
• More FAQs
• Glossary
• remote-references.html