Documentation ¶
Overview ¶
Package core contains only libsq core sub-packages. No package within pkg core may have dependencies on another libsq package unless that pkg is also in core.
Directories ¶
Path | Synopsis |
---|---|
Package cleanup provides functionality for executing cleanup functions.
|
Package cleanup provides functionality for executing cleanup functions. |
Package colorz provides supplemental color functionality.
|
Package colorz provides supplemental color functionality. |
Package debugz contains functionality for debugging.
|
Package debugz contains functionality for debugging. |
Package diffdoc provides core diff functionality, with a focus on streaming and concurrency.
|
Package diffdoc provides core diff functionality, with a focus on streaming and concurrency. |
internal/go-udiff
Package udiff computes differences between text files or strings.
|
Package udiff computes differences between text files or strings. |
internal/go-udiff/difftest
Package difftest supplies a set of tests that will operate on any implementation of a diff algorithm as exposed by diff "github.com/neilotoole/sq/libsq/core/diffdoc/internal/go-udiff"
|
Package difftest supplies a set of tests that will operate on any implementation of a diff algorithm as exposed by diff "github.com/neilotoole/sq/libsq/core/diffdoc/internal/go-udiff" |
internal/go-udiff/lcs
package lcs contains code to find longest-common-subsequences (and diffs)
|
package lcs contains code to find longest-common-subsequences (and diffs) |
internal/go-udiff/myers
Package myers implements the Myers diff algorithm.
|
Package myers implements the Myers diff algorithm. |
Package errz is sq's error package.
|
Package errz is sq's error package. |
Package execz builds on stdlib os/exec.
|
Package execz builds on stdlib os/exec. |
Package ioz contains supplemental io functionality.
|
Package ioz contains supplemental io functionality. |
checksum
Package checksum provides functions for working with checksums.
|
Package checksum provides functions for working with checksums. |
contextio
Package contextio provides io decorators that are context-aware.
|
Package contextio provides io decorators that are context-aware. |
httpz
Package httpz provides functionality supplemental to stdlib http.
|
Package httpz provides functionality supplemental to stdlib http. |
lockfile
Package lockfile implements a pid lock file mechanism.
|
Package lockfile implements a pid lock file mechanism. |
Package jointype enumerates the various SQL JOIN types.
|
Package jointype enumerates the various SQL JOIN types. |
Package kind encapsulates the notion of data "kind": that is, it is an abstraction over data types across implementations.
|
Package kind encapsulates the notion of data "kind": that is, it is an abstraction over data types across implementations. |
Package langz contains miscellaneous functionality supplemental to core golang stuff like slices and channels.
|
Package langz contains miscellaneous functionality supplemental to core golang stuff like slices and channels. |
Package lg contains utility functions for working with slog.
|
Package lg contains utility functions for working with slog. |
devlog
Package devlog contains a custom slog.Handler for developer-friendly log output.
|
Package devlog contains a custom slog.Handler for developer-friendly log output. |
lga
Package lga ("log attribute") holds constants for log attribute names.
|
Package lga ("log attribute") holds constants for log attribute names. |
lgm
Package lgm ("log message") contains constants for log messages.
|
Package lgm ("log message") contains constants for log messages. |
lgt
Package lgt provides a mechanism for getting a *slog.Logger that outputs to testing.T. See lgt.New.
|
Package lgt provides a mechanism for getting a *slog.Logger that outputs to testing.T. See lgt.New. |
slogbuf
Package slogbuf implements a Buffer that stores log records that can later be replayed on a slog.Handler.
|
Package slogbuf implements a Buffer that stores log records that can later be replayed on a slog.Handler. |
userlogdir
Package userlogdir has a single function, UserLogDir, that returns an OS-specific path for storing user logs.
|
Package userlogdir has a single function, UserLogDir, that returns an OS-specific path for storing user logs. |
Package oncecache contains a strongly-typed, concurrency-safe, context-aware, dependency-free, in-memory, on-demand object [Cache], focused on write-once, read-often ergonomics.
|
Package oncecache contains a strongly-typed, concurrency-safe, context-aware, dependency-free, in-memory, on-demand object [Cache], focused on write-once, read-often ergonomics. |
Package options implements config options.
|
Package options implements config options. |
Package progress contains progress bar widget functionality.
|
Package progress contains progress bar widget functionality. |
Package record holds the record.Record type, which is the core type for holding query results.
|
Package record holds the record.Record type, which is the core type for holding query results. |
Package retry implements retry functionality.
|
Package retry implements retry functionality. |
Package runtimez provides functionality supplemental to stdlib's runtime pkg.
|
Package runtimez provides functionality supplemental to stdlib's runtime pkg. |
Package schema provides functionality for modeling SQL constructs.
|
Package schema provides functionality for modeling SQL constructs. |
Package sqlz contains core types such as Kind and Record.
|
Package sqlz contains core types such as Kind and Record. |
Package stringz contains string functions similar in spirit to the stdlib strings package.
|
Package stringz contains string functions similar in spirit to the stdlib strings package. |
Package tablefq is a tiny package that holds the tablefq.T type, which is a fully-qualified SQL table name.
|
Package tablefq is a tiny package that holds the tablefq.T type, which is a fully-qualified SQL table name. |
Package tailbuf contains a tail buffer [Buf] of fixed size that provides a window on the tail of the items written via [Buf.Write].
|
Package tailbuf contains a tail buffer [Buf] of fixed size that provides a window on the tail of the items written via [Buf.Write]. |
Package termz contains a handful of terminal utilities.
|
Package termz contains a handful of terminal utilities. |
Package timez contains time functionality.
|
Package timez contains time functionality. |
Package tuning contains tuning options.
|
Package tuning contains tuning options. |
Package urlz contains URL utility functionality.
|
Package urlz contains URL utility functionality. |
Click to show internal directories.
Click to hide internal directories.