model

Documentation

Index

• Constants
• type CustomConfigParams
• type Model

Constants

const ConfigFileName = "config"

const ConfigFileType = "yaml"

const ConfigTmpFileName = "config.tmp"

const CustomConfigFileName = "config_custom"

const CustomConfigFileType = "yaml"

Types

type CustomConfigParams

type CustomConfigParams struct {
	ConfigModel interface{}
	Config      interface{}
}

type Model

type Model struct {
	// Application params (Which are custom defined by the user
	Application struct {
		// CurrentWorkingDirectory -> you can override this value! if nothing is set, no change will be performed, check IfEmptyCWDSetToExecPath
		CurrentWorkingDirectory string `yaml:"current_working_directory" mapstructure:"current_working_directory" default:"" env:"APP_CURRENT_WORKING_DIR"`
		// IfEmptyCWDSetToExecPath -> if no CurrentWorkingDirectory has been set, then it will bet set to the current executable's path!
		// if it's no, then the default CWD will remain!
		IfEmptyCWDSetToExecPath string `` /* 135-byte string literal not displayed */
		// Stage -> prod, dev, beta, testing etc...
		Stage string `yaml:"stage" mapstructure:"stage" default:"dev"`
		// App Data Path (all other subfolders will be stored there...)
		AppDataPath string `yaml:"app_data_path" mapstructure:"app_data_path" default:".appdata"`
		// Where the PIDs are saved!
		PIDsPath string `yaml:"pids_path" mapstructure:"pids_path" default:"pids"`
		// Where the FileLocks are saved
		LocksPath string `yaml:"locks_path" mapstructure:"locks_path" default:"locks"`
		// Temporary folder...
		TempPath string `yaml:"temp_path" mapstructure:"temp_path" default:"tmp"`
		// Storage Path -> where the data will be located
		StoragePath string `yaml:"storage_path" mapstructure:"storage_path" default:"storage"`
		// Cache Path -> where the caching files are being stored
		CachePath string `yaml:"cache_path" mapstructure:"cache_path" default:"cache"`
		// Certs Path -> where we store certificates for different use cases
		CertsPath string `yaml:"certs_path" mapstructure:"certs_path" default:"certs"`
		// ConfigsBackupPath -> we store here the backups of the configs... the app will automatically backup the
		// current config before launching the autoloader! Each time the app starts... it will do this backup!
		// This saves everyone in case of programming incorrection
		ConfigsBackupPath string `yaml:"configs_backup_path" mapstructure:"configs_backup_path" default:"configs_backup"`
		// How many seconds should wait until the app gracefully shuts down all the services before os.exit(0)
		OnShutdownWaitSeconds int `yaml:"on_shutdown_wait_seconds" mapstructure:"on_shutdown_wait_seconds" default:"2"`
		// This is the default timezone... wherever it runs, when the app starts, it will override the timezone with this value
		TimeZone string `yaml:"time_zone" mapstructure:"time_zone" default:"UTC"`
		// This param disables the override function on bootstrap only if necessary!
		DisableTimezoneOverride string `yaml:"disable_timezone_override" mapstructure:"disable_timezone_override" default:"no"`
	}
	// Different connections to different services
	Clients struct {
		DefaultDBClient string `yaml:"default_db_client" mapstructure:"default_db_client" default:"cockroach"`
		Cockroach       struct {
			// This is the default connection name -> from which we
			DefaultConn struct {
				// This is the default Instance Name
				InstanceId string `yaml:"instance_id" mapstructure:"instance_id" default:"default"`
			}
			Instances map[string]cockroachConfig.Config
		}
		// TODO: add PgSQL as a separate
		MySQL struct {
			DefaultConn struct {
				// This is the default Instance Name
				InstanceId string `yaml:"instance_id" mapstructure:"instance_id" default:"default"`
			}
			Instances map[string]mysqlConfig.Config
		}
		Redis struct {
			Instances struct {
			}
		}
		ElasticSearch struct {
			Instances struct {
			}
		}
		// Remote Procedure Call -> Through HTTP (For interprocess Communication)
		RPC struct {
			// Channel Name
			DefaultInstanceName string `yaml:"default_instance_name" mapstructure:"default_instance_name" default:"default"`
			Instances           struct {
			}
		}
		WebSocket struct {
			DefaultInstanceName string `yaml:"default_instance_name" mapstructure:"default_instance_name" default:"default"`
			Instances           map[string]websocketClientConfig.Config
		}
	}
	// The main Console!
	Console struct {
	}
	// Specific Autonomous services which are isolated and separately!
	Services struct {
	}

	// The one's that are listening on some ports (Servers)
	Listeners struct {
		Http struct {
			DefaultInstanceName string `yaml:"default_instance_name" mapstructure:"default_instance_name" default:"default"`
			Instances           map[string]httpConfig.Config
		}
		WebSocket struct {
			DefaultInstanceName string `yaml:"default_instance_name" mapstructure:"default_instance_name" default:"default"`
			Instances           map[string]websocketConfig.Config
		}
		UDP struct {
			DefaultInstanceName string `yaml:"default_instance_name" mapstructure:"default_instance_name" default:"default"`
			Instances           struct {
			}
		}
		UNIX struct {
			DefaultInstanceName string `yaml:"default_instance_name" mapstructure:"default_instance_name" default:"default"`
			Instances           struct {
			}
		}
		TCP struct {
			DefaultInstanceName string `yaml:"default_instance_name" mapstructure:"default_instance_name" default:"default"`
			Instances           struct {
			}
		}
		// Remote Procedure Call -> Through HTTP (For interprocess Communication)
		RPC struct {
			DefaultInstanceName string `yaml:"default_instance_name" mapstructure:"default_instance_name" default:"default"`
			Instances           struct {
			}
		}
	}

	Logging struct {
		// AppLogLevel -> it's for the app itself... it's the main (root) LOGGER!
		AppLogLevel int `yaml:"level" mapstructure:"level" default:"4"`

		LogsPath string `yaml:"logs_path" mapstructure:"logs_path" default:"logs"`
		// This is the default channel
		DefaultChannel string `yaml:"default_channel" mapstructure:"default_channel" default:"default"`
		// A default channel will always be and will be created automatically
		Channels map[string]loggingConfig.Config
	}
}