docs(wiki): document Unix socket connections (local and via SSH forward)#13
docs(wiki): document Unix socket connections (local and via SSH forward)#13debba wants to merge 3 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![kilo-code-bot[bot]](https://avatars.githubusercontent.com/in/2193792?s=60&v=4){kind=small}
|
|
||
| ## Forwarding to a Unix Socket | ||
|
|
||
| Some databases only listen on a Unix socket: MySQL with `skip_networking`, PostgreSQL with `listen_addresses = ''`. For those, set the optional **Socket Path** field in the SSH section of the connection editor. |
There was a problem hiding this comment.
SUGGESTION: Inconsistent field name casing
The connections table uses "Socket path" (sentence case), but this prose reference uses "Socket Path" (title case). For consistency with the table and other field references like "Allow interactive prompts", use sentence case here.
| Some databases only listen on a Unix socket: MySQL with `skip_networking`, PostgreSQL with `listen_addresses = ''`. For those, set the optional **Socket Path** field in the SSH section of the connection editor. | |
| Some databases only listen on a Unix socket: MySQL with `skip_networking`, PostgreSQL with `listen_addresses = ''`. For those, set the optional **Socket path** field in the SSH section of the connection editor. |
Reply with @kilocode-bot fix it to have Kilo Code address this issue.
Code Review SummaryStatus: 2 Issues Found | Recommendation: Address before merge Overview
Issue Details (click to expand)SUGGESTION
Files Reviewed (3 files)
Fix these issues in Kilo Cloud Previous Review Summaries (2 snapshots, latest commit aa7ffa1)Current summary above is authoritative. Previous snapshots are kept for context only. Previous review (commit aa7ffa1)Status: 3 Issues Found | Recommendation: Address before merge Overview
Issue Details (click to expand)SUGGESTION
Files Reviewed (3 files)
Fix these issues in Kilo Cloud Previous review (commit 0a7b883)Status: 1 Issue Found | Recommendation: Address before merge Overview
Issue Details (click to expand)SUGGESTION
Files Reviewed (2 files)
Reviewed by kimi-k2.6 · Input: 160.9K · Output: 21K · Cached: 131.4K |
Companion to TabularisDB/tabularis#492: the PR now also lets the MySQL and PostgreSQL drivers dial a Unix socket on the local machine directly, gated by the new unix_socket driver capability. Adds the field to the connection-profile table, a Local Unix socket section in connections.md, the capability row in plugins.md, and a cross-link from the SSH forwarding section.
debba
changed the title
|
|
||
| ### Local Unix socket (MySQL / PostgreSQL) | ||
|
|
||
| A database on the same machine can be reached through its Unix socket instead of TCP: set the optional **Local Socket Path** field in the General tab. No tunnel is involved — the drivers dial the socket directly. |
There was a problem hiding this comment.
SUGGESTION: Inconsistent field name casing\n\nThe connections table uses "Local socket path" (sentence case), but this prose reference uses "Local Socket Path" (title case). For consistency with the table, use sentence case.\n\nsuggestion\nA database on the same machine can be reached through its Unix socket instead of TCP: set the optional **Local socket path** field in the General tab. No tunnel is involved — the drivers dial the socket directly.\n\n\n---\nReply with @kilocode-bot fix it to have Kilo Code address this issue.
|
|
||
| ## Forwarding to a Unix Socket | ||
|
|
||
| Some databases only listen on a Unix socket: MySQL with `skip_networking`, PostgreSQL with `listen_addresses = ''`. For those, set the optional **Socket Path** field in the SSH section of the connection editor. (For a socket-only database on *your own* machine, no tunnel is needed — use the **Local Socket Path** field instead; see [Connections → Local Unix socket](/wiki/connections#local-unix-socket-mysql--postgresql).) |
There was a problem hiding this comment.
SUGGESTION: Inconsistent field name casing\n\nThe connections table uses "Socket path" and "Local socket path" (sentence case), but this prose uses "Socket Path" and "Local Socket Path" (title case). For consistency, use sentence case.\n\nsuggestion\nSome databases only listen on a Unix socket: MySQL with `skip_networking`, PostgreSQL with `listen_addresses = ''`. For those, set the optional **Socket path** field in the SSH section of the connection editor. (For a socket-only database on *your own* machine, no tunnel is needed — use the **Local socket path** field instead; see [Connections → Local Unix socket](/wiki/connections#local-unix-socket-mysql--postgresql).)\n\n\n---\nReply with @kilocode-bot fix it to have Kilo Code address this issue.
| | `connection_string_example` | string | Optional placeholder example shown in the connection string import field (e.g. `"clickhouse://user:pass@localhost:9000/db"`). `connectionStringExample` is also accepted. | | ||
| | `manage_tables` | bool | `true` to enable table and column management UI (Create Table, Add/Modify/Drop Column, Drop Table). Does not control index or FK operations. Defaults to `true`. | | ||
| | `readonly` | bool | When `true`, the driver is read-only: all data modification operations (INSERT, UPDATE, DELETE) are disabled in the UI. Table and column management is also hidden regardless of `manage_tables`. Defaults to `false`. | | ||
| | `unix_socket` | bool | `true` if the driver can connect through a local Unix socket instead of host:port. Shows the **Local Socket Path** field in the connection editor; the path reaches the plugin in the connection params as `unix_socket_path`. `unixSocket` is also accepted. Defaults to `false`. | |
There was a problem hiding this comment.
SUGGESTION: Inconsistent field name casing\n\nThe connections table uses "Local socket path" (sentence case), but this capability description uses "Local Socket Path" (title case). For consistency, use sentence case.\n\nsuggestion\n| `unix_socket` | bool | `true` if the driver can connect through a local Unix socket instead of host:port. Shows the **Local socket path** field in the connection editor; the path reaches the plugin in the connection params as `unix_socket_path`. `unixSocket` is also accepted. Defaults to `false`. |\n\n\n---\nReply with @kilocode-bot fix it to have Kilo Code address this issue.
The app now has one unix_socket_path field with tunnel-relative semantics (like Host and Port): dialed locally without a tunnel, by the SSH server with SSH enabled, ignored with Kubernetes. Merge the two connection-table rows into one, rewrite the connections.md section as 'Connecting over a Unix socket', point the SSH forwarding section at the shared field, and update the unix_socket capability row.
|
|
||
| ### Connecting over a Unix socket | ||
|
|
||
| The optional **Socket Path** field in the General tab names the Unix socket the database listens on, replacing Host and Port. Like Host and Port, it is interpreted from the perspective of whoever dials the destination: |
There was a problem hiding this comment.
SUGGESTION: Inconsistent field name casing
The connections table uses "Socket path" (sentence case), but this prose reference uses "Socket Path" (title case). For consistency with the table, use sentence case.
| The optional **Socket Path** field in the General tab names the Unix socket the database listens on, replacing Host and Port. Like Host and Port, it is interpreted from the perspective of whoever dials the destination: | |
| The optional **Socket path** field in the General tab names the Unix socket the database listens on, replacing Host and Port. Like Host and Port, it is interpreted from the perspective of whoever dials the destination: |
Reply with @kilocode-bot fix it to have Kilo Code address this issue.
| | `connection_string_example` | string | Optional placeholder example shown in the connection string import field (e.g. `"clickhouse://user:pass@localhost:9000/db"`). `connectionStringExample` is also accepted. | | ||
| | `manage_tables` | bool | `true` to enable table and column management UI (Create Table, Add/Modify/Drop Column, Drop Table). Does not control index or FK operations. Defaults to `true`. | | ||
| | `readonly` | bool | When `true`, the driver is read-only: all data modification operations (INSERT, UPDATE, DELETE) are disabled in the UI. Table and column management is also hidden regardless of `manage_tables`. Defaults to `false`. | | ||
| | `unix_socket` | bool | `true` if the driver can dial a local Unix socket instead of host:port. Shows the **Socket Path** field in the connection editor even without an SSH tunnel (with SSH enabled the field appears for every network driver, since the tunnel does the socket dialing); the path reaches the plugin in the connection params as `unix_socket_path`. `unixSocket` is also accepted. Defaults to `false`. | |
There was a problem hiding this comment.
SUGGESTION: Inconsistent field name casing
The connections table uses "Socket path" (sentence case), but this capability description uses "Socket Path" (title case). For consistency with the table, use sentence case.
| | `unix_socket` | bool | `true` if the driver can dial a local Unix socket instead of host:port. Shows the **Socket Path** field in the connection editor even without an SSH tunnel (with SSH enabled the field appears for every network driver, since the tunnel does the socket dialing); the path reaches the plugin in the connection params as `unix_socket_path`. `unixSocket` is also accepted. Defaults to `false`. | | |
| | `unix_socket` | bool | `true` if the driver can dial a local Unix socket instead of host:port. Shows the **Socket path** field in the connection editor even without an SSH tunnel (with SSH enabled the field appears for every network driver, since the tunnel does the socket dialing); the path reaches the plugin in the connection params as `unix_socket_path`. `unixSocket` is also accepted. Defaults to `false`. | |
Reply with @kilocode-bot fix it to have Kilo Code address this issue.
1 participant
Documents the Unix socket support shipped in TabularisDB/tabularis#492: a single Socket Path connection field with tunnel-relative semantics, like Host and Port.
skip_networking, PostgreSQLlisten_addresses = '') and how each backend implements it (direct-streamlocal@openssh.comon russh,ssh -L <port>:/path/to/socketon system ssh), now pointing at the shared field.unix_socketcapability row in the manifest capabilities table (enables local socket dialing; the value reaches the plugin asunix_socket_path).pnpm buildpassed on the initial commit; follow-up commits are Markdown-only content.