Table of contents

• Welcome to Hackolade Studio
  • Getting started
    • System requirements
    • Installation
      • Windows
      • Mac
      • Linux
      • Docker container
    • Software registration
    • 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
    • Use graph diagrams
    • Create a REST API model
    • Leverage a Polyglot data model
  • How-to guides
    • Add reusable definitions
    • Configure custom properties
    • Pre-populate new entities using snippets
    • Define composite key constraints
• NoSQL databases, storage formats, REST APIs
  • Polyglot Data Model
  • JSON Schema
  • Couchbase
  • DynamoDB
  • MongoDB
  • Download additional target plugins
    • Avro schema
    • BigQuery
    • Cassandra
    • Confluent Schema Registry
    • Cosmos DB SQL & MongoDB APIs
    • Cosmos DB Gremlin
    • Delta Lake on Databricks
    • DocumentDB
    • Elasticsearch
    • EventBridge
    • Event Hubs Azure Schema Registry
    • Firebase
    • Firestore
    • Glue Data Catalog
    • 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
    • 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
  • Schema versioning
  • Team collaboration
  • Model versioning
  • Polyglot Data Modeling
• Overview of user interface
  • Welcome page
  • Workspace
    • Title bar
    • Menu bar
    • Toolbar
    • Object browser pane
    • Central pane
    • Properties pane
  • JSON Schema Editor
  • Manipulating shapes
    • Containers in ER diagram
    • Entity boxes in ER diagram
    • Colors and font styles
    • Read-only views
    • Relationship links in ER diagram
    • Attribute boxes in hierarchical schema view
    • Choices
    • Graph shapes
  • 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
    • Migration to enhanced custom properties
  • Command Line Interface
  • Naming conventions
  • Lineage capture
  • Collibra Data Dictionary integration
  • MongoDB Field-Level Encryption
  • Repository
    • Concepts
    • Pre-requisites
    • Authentication
    • Clone a remote repository
    • Open a local repository
    • Explore repository
      • Explore files
      • Explore history
      • Explore stashed changes
      • Explore tags
    • Checkout a branch
    • Commit local changes
    • Pull remote commits
    • Push local commits
    • Solve conflicts
    • Connect to a repository hub
      • GitHub
      • Bitbucket Cloud
      • Bitbucket Server
      • Azure DevOps Repos
      • GitLab
    • Submit for review
    • Review change requests
    • Branch protection
    • 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
      • Target-specific
        • Avro schema
        • BigQuery DDL
        • Cassandra CQL
        • Cosmos DB SQL API scripts
        • Cosmos DB Gremlin script
        • Couchbase scripts
        • 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
        • TinkerPop Gremlin
  • Reverse-engineering
    • JSON document
    • YAML file
    • JSON Schema
    • YAML Schema
    • SQL DDL
    • XSD (XML Schema Definition)
      • From erwin
      • From ER/Studio
      • From PowerDesigner
      • From IBM InfoSphere
      • From Sparx Enterprise Architect
    • Excel template
    • Target-specific
      • Avro file or schema
      • Connect to a BigQuery instance
      • Connect to a Cassandra instance
        • Username/password
        • LDAP
        • SSH
        • Astra
      • 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 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
        • SSL
        • X.509
        • LDAP
        • Kerberos
        • SSH
      • 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
      • 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)
      • Connect to a SQL Server instance
        • SQL Server authentication
        • Windows authentication
        • Azure Active Directory authentication
        • SSL
        • SSH
      • Connect to Synapse
      • Swagger file
      • Connect to a TinkerPop instance
      • Connect to YugabyteDB
        • SSL
        • SSH
  • Suggest denormalization of a SQL schema
  • Infer Primary Keys and Foreign Key Relationships
  • Model-Driven API Generation
  • Generate mock data for testing
• Change log
  • v6.x
  • v5.x
  • v4.x
  • v3.x
  • v2.x
  • v1.x
  • v0.9
• FAQ and troubleshooting
  • How to get help and support?
  • Tips and tricks
  • Security concerns
  • Vulnerabilities
  • Installation FAQ
    • Professional Edition deployment options
    • Windows access denied error during upgrade
    • Mac EPERM: operation not permitted
    • Error message: spawn UNKNOWN
  • Licensing FAQ
    • Perpetual license or subscription: which one should I choose?
    • Transfer a license to a new computer
    • Managing multiple license keys and seats
  • Data modeling concepts FAQ
    • What is polymorphism?
    • What's a pattern field?
    • Regular expression
    • What is a choice?
  • 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"
  • 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
• Glossary