Documentation
¶
Overview ¶
Package ipc is locksql's console protocol: lockkit's transport and methods (package lockkit/ipc, re-exported here under the same names) plus the SQL methods and their types.
Index ¶
- Constants
- Variables
- func ListenShared(path string, gid int) (net.Listener, error)
- func Methods() []string
- func SocketPath(projectHash, profile string) (string, error)
- type ChangeParams
- type ChangeResult
- type Cred
- type DescribeParams
- type Health
- type HelloParams
- type HelloResult
- type PIIAddParams
- type PIIListResult
- type PlanParams
- type PlanResult
- type RPCError
- type Request
- type Response
- type RunParams
- type RunResult
- type StatusResult
- type TablesParams
- type TablesResult
Constants ¶
const ( MethodHello = kipc.MethodHello MethodStatus = kipc.MethodStatus MethodCatalogList = "catalog.list" MethodCatalogDescribe = "catalog.describe" MethodQueryPlan = "query.plan" MethodQueryRun = "query.run" MethodPIIList = kipc.MethodPIIList MethodPIIAdd = kipc.MethodPIIAdd MethodChangeRequest = kipc.MethodChangeRequest MethodLogout = kipc.MethodLogout )
Methods, spec §7. None of them loosens policy: change.request only queues a proposal that the console shows to the human.
const ( CodeRefused = kipc.CodeRefused CodeDenied = kipc.CodeDenied CodeTimeout = kipc.CodeTimeout CodeNoSuchPlan = kipc.CodeNoSuchPlan CodeConnLost = kipc.CodeConnLost CodePolicyPending = kipc.CodePolicyPending CodeParseError = kipc.CodeParseError CodeInvalidRequest = kipc.CodeInvalidRequest CodeMethodNotFound = kipc.CodeMethodNotFound CodeInvalidParams = kipc.CodeInvalidParams CodeInternal = kipc.CodeInternal )
Error codes (lockkit's).
const MaxIntent = 200
MaxIntent bounds PlanParams.Intent.
const MaxMessage = kipc.MaxMessage
MaxMessage is the largest message, excluding the newline, in bytes.
const ProtocolMajor = kipc.ProtocolMajor
ProtocolMajor is exchanged in the hello handshake.
Variables ¶
var ( ErrTooLarge = kipc.ErrTooLarge ErrAlreadyRunning = kipc.ErrAlreadyRunning Compatible = kipc.Compatible WriteMsg = kipc.WriteMsg ReadMsg = kipc.ReadMsg Listen = kipc.Listen PeerCred = kipc.PeerCred PeerAllowed = kipc.PeerAllowed )
var RuntimeDirEnv = product.P.RuntimeDirEnv()
RuntimeDirEnv overrides the runtime dir of locksql's sockets (LOCKSQL_RUNTIME_DIR).
Functions ¶
func ListenShared ¶
ListenShared opens locksql's console socket in the shared directory.
func SocketPath ¶
SocketPath is locksql's console socket of a project and profile.
Types ¶
type DescribeParams ¶
DescribeParams describes one table (catalog.describe); the result is an engine.TableInfo.
type Health ¶
type Health struct {
// Separated is set when the console runs as a dedicated account,
// apart from the agent (sysconf).
Separated bool `json:"separated"`
Display string `json:"display"`
// Privileges are the privilege audit's findings: what the database
// account can do beyond the profile tier.
Privileges []string `json:"privileges"`
// ExplainOK reports that EXPLAIN works on the server.
ExplainOK bool `json:"explain_ok"`
// ReadOnly reports that the session is read-only on the server.
ReadOnly bool `json:"read_only"`
}
Health is the console's own diagnosis of its setup.
type PlanParams ¶
type PlanParams struct {
DB string `json:"db"`
SQL string `json:"sql"`
Unmask bool `json:"unmask,omitempty"`
// Intent is one line from the agent saying why the query is needed,
// shown to the human on the approval screen and audited. It is
// untrusted text of at most MaxIntent bytes.
Intent string `json:"intent,omitempty"`
}
PlanParams asks for a plan (classification, EXPLAIN, weight, approval).
type PlanResult ¶
type PlanResult struct {
PlanID string `json:"plan_id"`
Profile string `json:"profile"`
Host string `json:"host"`
DB string `json:"db"`
SQL string `json:"sql"`
Class string `json:"class"`
Verdict string `json:"verdict"`
Summary string `json:"summary"`
Reasons []string `json:"reasons,omitempty"`
Unmask bool `json:"unmask,omitempty"`
// Values are the placeholder names the human typed in this console
// session: '${name}' reuses a value without a prompt.
Values []string `json:"values,omitempty"`
}
PlanResult is an approved, one-shot plan.
type RunParams ¶
type RunParams struct {
PlanID string `json:"plan_id"`
}
RunParams runs an approved plan.
type RunResult ¶
type RunResult struct {
Columns []string `json:"columns"`
Rows [][]any `json:"rows"`
Truncated bool `json:"truncated"`
Affected int64 `json:"affected,omitempty"`
// CutCells counts the cells whose value was cut (it ends with "…"):
// longer than max_cell_chars, or than the engine's per-cell cap.
CutCells int `json:"cut_cells,omitempty"`
// DurationMS is no longer filled: timings stay on the console.
DurationMS int64 `json:"duration_ms,omitempty"`
Text string `json:"text,omitempty"`
}
RunResult is a capped, masked result. Text is the rendered TSV.
type StatusResult ¶
type StatusResult struct {
Profile string `json:"profile"`
Engine string `json:"engine"`
Host string `json:"host"`
HostConfirmed bool `json:"host_confirmed"`
Production bool `json:"production"`
AutoApprove bool `json:"auto_approve"`
AllowUnmask bool `json:"allow_unmask"`
ShowResults bool `json:"show_results"`
Tier string `json:"tier"`
Databases []string `json:"databases"`
Limits config.Limits `json:"limits"`
IdleTimeoutInS int `json:"idle_timeout_in_s"`
SessionEndsInS int `json:"session_ends_in_s"`
// Health is what the console found at start-up, for locksql doctor.
Health *Health `json:"health,omitempty"`
}
StatusResult describes the console session.
type TablesParams ¶
type TablesParams struct {
DB string `json:"db"`
}
TablesParams lists the tables of a database (catalog.list).
type TablesResult ¶
TablesResult answers catalog.list.
Source Files