modulepackage
2.2.17
Repository: https://github.com/ontariosystems/isclib.git
Documentation: pkg.go.dev
# README
isclib
Go library for interacting with InterSystems Corporation products like Caché, Ensemble, and IRIS Data Platform
It provides methods for determining if ISC products are installed and for interacting with instances of them
Some example code can be found in the GoDocs
# Functions
AvailableCommands returns a Commands bitmask indicating which ISC command lines are available.
CControlPath returns the current path to the ccontrol executable.
CSessionPath returns the current path to the csession executable.
ExecuteTemporaryDirectory returns the directory where temporary files for ObjectScript execution will be placed.
InstanceFromQList will parse the output of a qlist into an Instance struct.
IrisPath returns the current path to the iris executable.
IrisSessionCommand returns the current string for the iris session command.
LoadInstance retrieves a single instance by name.
LoadInstances returns a listing of all Caché/Ensemble instances on this system.
LoadParametersISC will load the parameters contained in the provided reader It returns the ParametersISC data structure and any error encountered.
NewImportDescription creates and returns a new import description based on the provided glob pattern and ISC qualifiers.
ParseProduct parses a string representing a ISC product into a Product.
SetCControlPath sets the current path to the ccontrol executable.
SetCSessionPath sets the current path to the csession executable.
SetExecuteTemporaryDirectory sets the directory where temporary files for ObjectScript execution will be placed.
SetIrisPath sets the current path to the iris executable.
SetIrisSessionCommand sets the current string for the iris session command.
ToggleZSTU ensures that the cpf file at the path provided has the ZSTU setting set to true or false based on the provided boolean value.
# Constants
Cache is the ISC product Cache.
CacheDatName is the common name for a Cache database file.
CControlCommand indicates that the ccontrol command is available.
CSessionCommand indicates that the csession command is available.
DefaultImportQualifiers are the default ISC qualifiers used for importing source.
Ensemble is the ISC product Ensemble.
InstanceStatusDown represents an instance that is down.
InstanceStatusInhibited represents an instance that is up but sign-ons have been inhibited due to an issue.
InstanceStatusMissingIDS represents an instance that is up but missing a non-critical (but expected) information file.
InstanceStatusPrimaryTransition represents an instance that is up but the primary mirror member is being determined.
InstanceStatusRunning represents a running instance.
InstanceStatusUnknown represents a blank/unknown instance status.
Iris is the ISC product IRIS Data Platform.
IrisCommand indicates that the iris command is available.
IrisDatName is the common name for a Iris database file.
NoCommand indicates the none of the ISC command lines are available.
None indicates that there are no ISC products.
# Variables
ErrLoadFailed is an error signifying that the loading of the source code failed.
ErrMissingPathSeparator is an error signifying a missing path separator in the glob pattern.
ErrPathAfterRecursiveDirs is an error signifying that additional path information is included after the ** in the glob pattern.
ErrTooManyRecursiveDirs is an error signifying too many ** are included in the glob pattern.
ErrWildcardInDirectory is an error signifying that a wildcard has been included in the directory part of the glob pattern.
FS is a wrapper for the file system.
# Structs
Dat holds information that pertains an existing ISC database.
ImportDescription holds information needed for constructing a valid ISC $SYSTEM.OBJ.ImportDir command.
An Instance represents an instance of Caché/Ensemble/Iris on the current system.
ParametersISCEntry represents a single entry from the parameters ISC file.
No description provided by the author
No description provided by the author
# Type aliases
Commands represents the ISC command lines that are available.
Instances represents a collection of Caché/Ensemble instances.
An InstanceStatus represents one of the various status associated with Caché/Ensemble instances.
ParametersISC represents the contents of the parameters ISC file.
ParametersISCGroup represents a group of related parameters from the ISC file.
Product represents a particular ISC product.