Start here
Connections
Create and test connection profiles using a MongoDB URI or individual connection fields.
Use a connection string
Open Application menu → Manage connections → Add. New profiles start in Connection string mode. Give the profile a name and enter a URI supplied by your MongoDB administrator or hosting provider.
mongodb://localhost:27017/shop
mongodb+srv://example.mongodb.net/shop
These illustrate the two supported schemes; the second hostname is a placeholder. Authentication credentials, TLS settings and network access must match your deployment. Test details checks the draft without saving it. Add connection saves it.
Use individual fields
Choose the Manual tab to enter the host, port, default database, username, password and authentication database separately. The form also includes TLS, authentication mechanism, replica-set name, routing/read preference and additional URI options.
- A standard connection uses
mongodb://. A blank port defaults to27017. - A DNS SRV connection uses
mongodb+srv://, one hostname and no port. DNS supplies the server list; TLS is enabled by default. - Authentication database is where the user authenticates. It can differ from the database you want to browse.
- Enter decoded usernames and passwords in the manual form; Palryn encodes them into the URI.
- Use additional name/value options for settings such as certificate paths and timeouts.
Switch back to Connection string for direct URI editing. URI forms that cannot be represented by the manual editor remain editable as source.
Test, edit and reconnect
Saved connection cards provide Test, Connect, Reconnect and Disconnect. Testing a profile checks connectivity; it does not execute one of your query drafts.
Edit retrieves the saved details, initially masking the password and URI. Use the eye controls to reveal them when needed. Changing the connection string disconnects the existing session; name and colour changes preserve the session and drafts. Reconnect and rerun queries after changing the connection string to obtain results from the updated target.
Right-click a connection card for Open workspace, Open Shell, Edit and Copy connection string. Navigation and profile actions are grouped separately. Open workspace is available once connected; you can also use the card's visible controls.
A connection can be opened directly from the workspace selector or added to a named workspace. The same saved profile can be used in more than one workspace.
Distinguish environments with connection colours
In Add/Edit connection → Connection colour, choose None, a palette colour or a custom colour. For example, use red for Production, amber for Test and blue for Dev. Colours belong to the saved profile and follow it across workspaces and restarts.
Explorer shows a leading colour marker and coloured connection icon. Every collection, aggregation and Shell tab has a matching top strip, including inactive tabs, and the active editor's target label has a matching dot. The selected direct connection also has a dot beside the workspace selector. Connection names remain visible, so colour is an additional cue rather than the only way to identify a target.
Choose None and save to remove a colour. Name and colour saves update metadata without disconnecting or clearing loaded results; changing the connection string still disconnects the session. A colour is only a visual label: red does not enable write protection, and another colour does not mean a database is safe to change.
Protect production connections against writes
In Explorer, right-click a connection name and choose Write Protection, including collapsed connections in named workspaces. Keyboard users can focus the row and press Shift+F10 or the context-menu key. A shield beside the connection name shows that the connection or some of its databases are protected; writable connections have no shield.
When adding a profile, select Protect this connection against writes. For existing profiles, click the protection indicator on a connection card or the clickable status chip beside Filter in a collection-query tab, choose Write protection settings while editing a profile, or open Application menu → Write protection. The chip is followed by the connection and namespace; narrow panes truncate that text with a full-name tooltip and wrap the query-mode controls as needed. Aggregation and shell tabs retain their top-level indicator. Explorer database and collection context menus also offer Write protection….
Expand Persistent protection to protect the entire connection or use the single Protected databases list, one entry per line. Plain names such as production match exactly; slash-delimited entries such as /^prod(?:_|$)/ or /(?i)^production$/ are regex patterns. Put flags inside the expression. Patterns match substrings unless anchored with ^/$, and also protect matching databases created later. Rust regex syntax supports Unicode and inline flags, but not look-around or backreferences. Invalid patterns are rejected; names such as prod(archive) remain literal. Existing saved patterns appear with delimiters automatically. Choose Save protection settings. Connection protection applies to all its databases and collections; a database setting cannot override it. Existing profiles remain writable until you enable protection.
For deliberate changes, open protection from the collection you are working on. The temporary allowance defaults to that collection for five minutes. Wider database/connection scopes and 1, 5, 15 or 30 minute durations are available explicitly. Multiple allowances can coexist, including overlapping scopes; granting the same scope renews its timer. The Active allowances list shows each target, countdown and expiry. Each row's Protect now ends only that allowance; overlapping grants remain active. Protect all now ends every allowance on the selected connection. Hover an Explorer shield to see the remaining time; overlapping grants use the latest expiry that covers that target.
Protection is checked in Palryn's backend before writes, including document changes, imports, collection copies, namespace operations, views, indexes and user/role changes. Reads and exports remain available. Unsaved document edits are retained when an allowance ends. Operations already sent can still finish; completed changes are not undone. Background jobs check again between write batches or steps.
Collection replacement and renaming may require a database allowance because they change multiple namespaces. User/role changes require connection-wide permission. Shells and external restores are blocked while any part of the connection is protected, even with a temporary allowance. Stop running shells/restores before changing persistent protection.
Allowances end on restart, connection changes, disconnect/reconnect, or saving protection settings. The same saved profile shares protection across workspaces; separate profiles pointing to the same server do not. This prevents accidents through Palryn and complements, rather than replaces, MongoDB read-only credentials.
Replica set status and health
After connecting, choose the heartbeat icon labelled Replica set status in the Explorer toolbar. In a named workspace, you can also right-click a connection heading and choose Replica set status….
The read-only view shows the replica-set name, observing member, server time and election term, plus member states, Up/Down/Unknown reachability, estimated replication lag and heartbeat latency. Expand a member for uptime, sync source, heartbeat messages and election details. It loads when opened; choose Refresh for a new snapshot.
Hidden members show Hidden alongside their state, such as SECONDARY · Hidden. Expanded details show Hidden as Yes, No or Unknown. This uses an additional read-only replSetGetConfig request, also permitted by clusterMonitor. If configuration is unavailable or access is denied, member health still loads and visibility is marked Unknown. Refresh after changing replica-set configuration.
Data reflects one member's heartbeat-based view and can be several seconds old. Lag compares applied oplog timestamps against the reported reachable primary at one-second resolution; idle time is not lag. A dash means unavailable or not applicable, including arbiters, unavailable members or a missing primary. Up indicates reachability, not a guarantee that the member can serve reads or writes.
The connected user needs the cluster-level replSetGetStatus privilege, included in the clusterMonitor role on admin. Standalone servers have no replica-set status. For a sharded deployment, connect directly to the shard or config-server replica set instead of mongos. Some hosted tiers restrict the command. The dialog explains unavailable status and permission failures.
Clipboard shortcuts
If the connection manager detects a new MongoDB URI on your clipboard while no editor is open, it offers Add clipboard connection. Accepting opens a prefilled draft; review it and explicitly save it. Dismissing the offer does not change a saved profile.
Copy connection string copies the complete saved URI, including any embedded credentials. It is intended for places where you need the full connection details.
Where connection details live
Saved connection URIs use the operating system keychain: Windows Credential Manager on Windows, or an available, unlocked Secret Service on Linux. Workspace drafts contain profile references, not the saved credentials.
If a profile cannot be saved or retrieved, check that the keychain service is available and unlocked. For connection failures, see connection troubleshooting.