Documentation
¶
Index ¶
- Constants
- func Execute() error
- func ExitWithCode(logger *logging.Logger, exitCode foundry.ExitCode, msg string, err error)
- func ExitWithCodeStderr(exitCode foundry.ExitCode, msg string, err error)
- func ExitWithCodeWriter(w io.Writer, exitCode foundry.ExitCode, msg string, err error)
- func GetAppIdentity() *appidentity.Identity
- func IsReadOnly() bool
- func ProbeExitCode(err error) (foundry.ExitCode, bool)
- func SetVersionInfo(version, commit, buildDate string)
Constants ¶
const ( // DefaultObjectBatchSize is the number of objects to batch before flushing. // Tuned for memory efficiency on large buckets (1M+ objects). DefaultObjectBatchSize = 5000 // DefaultPrefixBatchSize is the number of prefixes to batch before flushing. // Prefixes are fewer than objects, so smaller batches are fine. DefaultPrefixBatchSize = 1000 // DefaultFlushTimeout is the timeout for final flush operations in Close(). // Prevents indefinite hangs if the database stalls. DefaultFlushTimeout = 2 * time.Minute )
Default batch sizes and timeouts for streaming ingestion.
Variables ¶
This section is empty.
Functions ¶
func Execute ¶
func Execute() error
Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.
func ExitWithCode ¶
ExitWithCode exits the program with a semantic foundry exit code and logs the error. This helper ensures consistent error logging with exit code metadata before exiting.
Parameters:
- logger: The logger to use for error output (can be nil for early failures)
- exitCode: The foundry exit code constant (e.g., foundry.ExitConfigInvalid)
- msg: Human-readable error message
- err: The underlying error (can be nil)
func ExitWithCodeStderr ¶
ExitWithCodeStderr is a variant that writes to stderr without a logger. Use this for early failures before logger initialization.
Parameters:
- exitCode: The foundry exit code constant
- msg: Human-readable error message
- err: The underlying error (can be nil)
func ExitWithCodeWriter ¶
ExitWithCodeWriter exits with a semantic foundry exit code, writing plain diagnostic output to the supplied writer instead of using the CLI logger.
func GetAppIdentity ¶
func GetAppIdentity() *appidentity.Identity
GetAppIdentity returns the loaded app identity (only valid after initConfig)
func IsReadOnly ¶
func IsReadOnly() bool
IsReadOnly reports whether the CLI is running with provider-side mutations disabled. It can be enabled via `--readonly` or by setting the environment variable `GONIMBUS_READONLY=1`.
func ProbeExitCode ¶
ProbeExitCode recognizes only content-probe's typed outcome. Other command errors retain their existing process dispatch, regardless of message text.
func SetVersionInfo ¶
func SetVersionInfo(version, commit, buildDate string)
SetVersionInfo is called by main package to set version information
Types ¶
This section is empty.
Source Files
¶
- app_data_root.go
- atlas.go
- connection_pool_apply.go
- content.go
- content_head.go
- content_probe.go
- content_probe_terminal.go
- crawl.go
- diagnostic_output.go
- doctor.go
- envinfo.go
- exit.go
- filespace_unix.go
- health.go
- index.go
- index_acquire.go
- index_build.go
- index_build_engine_adapter.go
- index_build_heartbeat.go
- index_build_ingest.go
- index_build_managed.go
- index_build_progress.go
- index_build_result.go
- index_build_since.go
- index_build_spill.go
- index_compare.go
- index_doctor.go
- index_enrich_head.go
- index_enrich_head_durable.go
- index_export.go
- index_gc.go
- index_gc_execute.go
- index_gc_plan.go
- index_hub.go
- index_hub_bridge.go
- index_hub_format.go
- index_hydrate.go
- index_jobs.go
- index_jobs_gc.go
- index_jobs_logs.go
- index_jobs_plan_stalled.go
- index_jobs_recover_stalled.go
- index_jobs_stop.go
- index_latest_cas.go
- index_leases.go
- index_list.go
- index_migrate_match_scope.go
- index_query.go
- index_query_receipt.go
- index_query_receipt_output.go
- index_reader_resolve.go
- index_set_maintenance.go
- index_stats.go
- index_substrate_paths.go
- inspect.go
- inspect_pair.go
- interrupt.go
- opcheckpoint_runtime.go
- output_dest.go
- preflight.go
- provider_source.go
- root.go
- serve.go
- stream.go
- stream_get.go
- stream_head.go
- stream_put.go
- transfer.go
- transfer_reflow.go
- transfer_reflow_adapter.go
- transfer_reflow_checkpoint.go
- transfer_reflow_collision.go
- transfer_reflow_config.go
- transfer_reflow_dest.go
- transfer_reflow_errors.go
- transfer_reflow_ifabsent.go
- transfer_reflow_provenance.go
- transfer_reflow_providers.go
- transfer_reflow_source.go
- transfer_reflow_stats.go
- tree.go
- version.go