Start here
Welcome to Palryn
Explore Palryn's features and find the right guide for your MongoDB workflow.
New to Palryn? Start with Your first query: connect, open a collection and explore a document. You do not need to configure a named workspace first.
What is Palryn?
Palryn is a desktop client for MongoDB. It brings connection profiles, query editors, document inspection and database tools into one workspace. Work with a single connection or keep several connections together in a named workspace.
Documents retain their BSON types, including ObjectId, dates, Decimal128, exact 64-bit integers, UUID, legacy C#/Java/Python UUID values and MD5 digests. You can move between a compact table, expandable document fields and source-based workflows.
Choose a guide
Feature overview
| Area | What you can do |
|---|---|
| Connections | Save and test standard or SRV connection profiles, with authentication, TLS, replica-set options, connection colours and scoped write protection. |
| Workspaces | Combine connections, search across their databases and collections, filter Explorer namespaces, keep independent query tabs and compare results in two editor groups. |
| Queries | Use Source, Visual or Chips filters, typed BSON examples, sampled autocomplete, server sort/projection and paging. |
| Documents | Inspect nested data, edit values or source, rename properties, insert, duplicate and delete documents. |
| Relations | Map a field to another collection, preview referenced documents and build display templates combining target fields beside an ID. |
| Database tools | Manage indexes and standard views, analyze a schema sample, read storage statistics and rename collections. |
| Aggregation | Edit stages visually or as source, compare a stage's input/output, create stages from result properties and export loaded or full results. |
| Data transfer | Import/export JSON and CSV, export Excel workbooks, copy collections, and use MongoDB backup folders or archives. |
| Shell and access | Run real mongosh scripts and administer users, roles and direct privileges. |
| Preferences | Choose bundled or custom themes and customize fonts, BSON colours, dates, query modes, notifications, tool paths and workspace restoration. |
How to read these guides
Application menu means the three-line button at the top right of Palryn. A path such as Collection tools → Relations… means right-click the collection, open that submenu, then choose the action.
Examples use fictional shop.orders and shop.customers collections. Substitute your own database, field names and identifiers. Query examples are entered in Palryn's filter editor unless a guide explicitly says to use Shell or an import file.
These guides cover the released Palryn 0.7.0. Find the Windows installer, Linux AppImage and native DEB/RPM packages in Your first query. For common problems, use Troubleshooting.