LogoLogo
HomeGitHub RepoBook Demo
dev
dev
  • About Quilt
  • Architecture
  • Mental Model
  • Metadata Management
  • Metadata Workflows
  • Quilt Platform (Catalog) User
    • About the Catalog
    • Bucket Browsing
    • Document Previews
    • Embeddable iFrames
    • Packaging Engine
    • Query
    • Quilt+ URIs
    • Qurator Omni
    • Search
    • Visualization & Dashboards
    • Advanced
      • Athena
      • Elasticsearch
      • Removing Stacks
  • Quilt Platform Administrator
    • Admin Settings UI
    • Catalog Configuration
    • Cross-Account Access
    • Enterprise Installs
    • quilt3.admin Python API
    • Advanced
      • Package Events
      • Private Endpoints
      • Restrict Access by Bucket Prefix
      • S3 Events via EventBridge
      • SSO Permissions Mapping
      • Tabulator
      • Troubleshooting
        • SSO Redirect Loop
    • Best Practices
      • GxP for Security & Compliance
      • Organizing S3 Buckets
  • Quilt Python SDK
    • Installation
    • Quick Start
    • Editing a Package
    • Uploading a Package
    • Installing a Package
    • Getting Data from a Package
    • Example: Git-like Operations
    • API Reference
      • quilt3
      • quilt3.Package
      • quilt3.Bucket
      • quilt3.hooks
      • Local Catalog
      • CLI, Environment
      • Known Limitations
      • Custom SSL Certificates
    • Advanced
      • Browsing Buckets
      • Filtering a Package
      • .quiltignore
      • Manipulating Manifests
      • Materialization
      • S3 Select
    • More
      • Changelog
      • Contributing
      • Frequently Asked Questions
      • Troubleshooting
  • Quilt Ecosystem Integrations
    • Benchling Packager
    • Event-Driven Packaging
    • Nextflow Plugin
Powered by GitBook
On this page
  • Brief tour
  • Admin UI

Was this helpful?

  1. Quilt Platform (Catalog) User

About the Catalog

PreviousMetadata WorkflowsNextBucket Browsing

Last updated 2 years ago

Was this helpful?

The Quilt Catalog is the second half of Quilt. It provides an interface on top of your S3 bucket that brings Quilt features like data packages and search to the web.

.

Note that you can use the Quilt Python API without using the Quilt Catalog, but they are designed to work together.

Brief tour

The Quilt Catalog provides a homepage for your data catalog, based on a README.md file that you can optionally create at the top of your bucket.

Browse

The Catalog lets you navigate packages in the registry using the "Packages" tab.

You can also browse the underlying S3 objects using the "Bucket" tab.

Search

Upload package

The name should have the format namespace/package-name.

The message needs to add notes on a new revision for this package.

Files are the content of your package.

The associated workflow contains the rules for validating your package.

The metadata can be added with the JSON editor for both packages and individual file entries within a package, represented as a key/value table with infinite nesting. If your workflow contains a JSON schema, you will have predefined key/value pairs based on the schema.

JSON editor

To add a new key/value field double click on an empty cell and type the key name, then press "Enter" or "Tab", or click outside of the cell. To change the value double click on that value.

Values can be strings, numbers, arrays, or objects. Every value that you type will be parsed as JSON.

Limitations

  • References and compound types are not currently supported.

Push to bucket

Summarize

Adding a quilt_summarize.json file to a data package (or S3 directory path) will enable content preview right on the landing page.

Admin UI

Catalogs also enable you to search the contents of your bucket. We support both unstructured (e.g. "San Francisco") and structured with (e.g. "metadata_key: metadata_value") search. Hits are previewed right in the search results.

You can upload a new package providing the name of the package, commit message, files, metadata, and .

You can push an existing data package from one S3 bucket to another. To use this feature consult the page.

See for details.

The Quilt Catalog includes an Admin panel where you can manage users and buckets in your stack and customize the display of your Quilt Catalog. See for details.

.

Query String Queries
workflow
Workflows
Admin UI docs
To learn more, check out the public demo catalog
For a hands-on demo, check out the public demo catalog
Homepage
Packages tab
Files tab
Search
Package landing page
Visualization & dashboards documentation