iRODS Documentation
3.0.0
This documentation is generated from the iRODS code.
- msiAdmChangeCoreIRB - Changes the core.irb file from the client
- msiAdmAppendToTopOfCoreIRB - Prepends another irb file to the core.irb file
- msiAdmAddAppRuleStruct - Adds application level IRB rules and DVM and FNM mappings to the rule engine
- msiAdmClearAppRuleStruct - Clears application level IRB rules and DVM and FNM mappings that were loaded into the rule engine
- msiAdmShowIRB - Displays the currently loaded rules
- msiAdmShowDVM - Displays the currently loaded data variable mappings
- msiAdmShowFNM - Displays the currently loaded microservices and action (function) name mappings
- msiAdmReadRulesFromFileIntoStruct - Reads a rule configuration file into a rule structure
- msiAdmInsertRulesFromStructIntoDB - Writes a rule structure into the current rule base
- msiGetRulesFromDBIntoStruct - Populates a rule structure with rules from the given base name
- msiAdmWriteRulesFromStructIntoFile - Writes to file the rules within a given rule structure
- msiAdmReadDVMapsFromFileIntoStruct - Reads a DVM configuration file into a DVM structure
- msiAdmInsertDVMapsFromStructIntoDB - Writes a DVM structure into the current DVM base
- msiGetDVMapsFromDBIntoStruct - Populates a DVM structure with DVMs from the given base name
- msiAdmWriteDVMapsFromStructIntoFile - Writes to file the DVMs within a given DVM structure
- msiAdmReadFNMapsFromFileIntoStruct - Reads a FNM configuration file into a FNM structure
- msiAdmInsertFNMapsFromStructIntoDB - Writes an FNM structure into the current FNM base
- msiGetFNMapsFromDBIntoStruct - Populates an FNM structure with FNMs from the given base name
- msiAdmWriteFNMapsFromStructIntoFile - Writes to file the FNMs within a given FNM structure
- msiAdmReadMSrvcsFromFileIntoStruct - Reads a microservice configuration file into a microservice structure
- msiAdmInsertMSrvcsFromStructIntoDB - Writes a microservice structure into the current microservices base
- msiGetMSrvcsFromDBIntoStruct - Populates a microservice structure with microservices from the given base name
- msiAdmWriteMSrvcsFromStructIntoFile - Writes to file the microservices within a given microservice structure
Can be called by client through irule.
Can be called by client through irule.
Can be called by client through irule.
Can be called by client through irule.
iCAT System Services
- msiVacuum - Postgres vacuum - done periodically
- msiQuota - Calculates storage usage and sets quota values
- msiCommit - Commits the database transaction
- msiRollback - Rollback the current database transaction
- msiSetACL - Changes the ACL for a given pathname, either a collection or a data object
- msiCreateUser - Creates a new user
- msiDeleteUser - Deletes a user
- msiAddUserToGroup - Adds a user to a group
- msiCreateCollByAdmin - Creates a collection by administrator
- msiDeleteCollByAdmin - Deletes a collection by administrator
- msiRenameLocalZone - Renames the local zone by updating various tables
- msiRenameCollection - Renames a collection; used via a rule with the above msiRenameLocalZone
- msiExecStrCondQuery - Creates an iCAT query, given a condition string, and executes it and returns the values
- msiExecStrCondQueryWithOptions - Like msiExecStrCondQuery, with extra options
- msiExecGenQuery - Executes a given general query structure and returns results
- msiMakeQuery - Creates a psuedo-SQL query, given a select list and a condition list
- msiGetMoreRows - Continues an unfinished query and msiExecStrCondQuery and returns results
- msiCloseGenQuery - Closes an unfinished query. Based on msiGetMoreRows.
- msiMakeGenQuery - A combination of msiMakeQuery and msiExecGenQuery and returns the results of the execution
- msiGetContInxFromGenQueryOut - Gets continue index value generated by msiExecGenQuery
- msiAddSelectFieldToGenQuery - Sets a select field in a genQueryInp_t
- msiPrintGenQueryInp - Prints the given GenQueryInp_MS_T to the given target buffer
- msiAddConditionToGenQuery - Adds a condition to a genQueryInp_t
- msiPrintGenQueryOutToBuffer - Writes the contents of a GenQueryOut_MS_T into a BUF_LEN_MS_T
- msiDeleteUnusedAVUs - Deletes unused AVUs from the iCAT
- msiRdaToStdout - Calls new RDA functions to interface to an arbitrary database returning results in stdout
- msiRdaToDataObj - As above but stores results in an iRODS DataObject
- msiRdaNoResults - As above, performs a SQL operation but without resulting output
- msiRdaCommit - Commit changes to the database
- msiRdaRollback - Rollback (don't commit) changes to the database
- msiStrlen - Returns the length of a given string
- msiStrchop - Removes the last character of a given string
- msiSubstr - Returns a substring of the given string
- msiNcOpen - Open an iRODS data object for netcdf operation (equivalent to nc_open)
- msiNcCreate - Create an iRODS data object for netcdf operation (equivalent to nc_create)
- msiNcClose - Close an opened iRODS data object (equivalent to nc_close)
- msiNcInqId - A general netcdf inquiry for id (equivalent to nc_inq_dimid, nc_inq_varid, .... This msi is superceded by the more comprehensive msiNcInq API
- msiNcInqWithId - A general netcdf inquiry with id (equivalent nc_inq_dim, nc_inq_dim, nc_inq_var ....) This API is superceded by the more comprehensive rcNcInq API
- msiNcGetVarsByType - A general NETCDF variable subsetting microservice (equivalent to nc_get_vars_type API)
- msiNcGetArrayLen - Get the array length of a NcInqWithIdOut_MS_T or NcGetVarOut_MS_T
- msiNcGetNumDim - Get the number of dimensions of a NcInqWithIdOut_MS_T or NcGetVarOut_MS_T
- msiNcGetDataType - Get the dataType of a NcInqWithIdOut_MS_T, NcGetVarInp_MS_T or NcGetVarOut_MS_T
- msiNcGetElementInArray - Get the value of an element in an array
- msiFloatToString - Convert a floating point number to a string
- msiNcInq - A gGeneral netcdf inquiry (This msi is more comprehensive and supercede the msiNcInqId and msiNcInqWithId msi)
- msiNcGetNdimsInInqOut - Get the number of dimensions of a variable in a NcInqOut_MS_T
- msiNcGetNattsInInqOut - Get the number of attributes associated with a variable in a NcInqOut_MS_T
- msiNcGetNvarsInInqOut - Get the number of variables in a NcInqOut_MS_T
- msiNcGetFormatInInqOut - Get the format of the NETCDF file in a NcInqOut_MS_T
- msiNcGetVarNameInInqOut - Get the name of a variable in an array of variables in a NcInqOut_MS_T
Can only be called by the server process
Can only be called by an administrator
- msiRecursiveCollCopy - Recursively copies a collection and its contents including metadata
- msiGetDataObjACL - Gets ACL (Access Control List) for a data object in | separated format
- msiGetCollectionACL- Gets ACL (Access Control List) for a collection in | separated format
- msiGetDataObjAVUs - Retrieves metadata AVU triplets for a data object and returns them as an XML file
- msiGetDataObjPSmeta - Retrieves metadata AVU triplets for a data object in | separated format
- msiGetCollectionPSmeta- Retrieves metadata AVU triplets for a collection in | separated format
- msiGetDataObjAIP - Gets the Archival Information Package of a data object in XML format
- msiLoadMetadataFromDataObj - Parses an iRODS object for new metadata AVUs from | separated format
- msiExportRecursiveCollMeta - Exports metadata AVU triplets for a collection and its contents in | separated format
- msiCopyAVUMetadata - Copies metadata triplets from an iRODS object to another
- msiStripAVUs - Strips a data object of its metadata AVU triplets
- msiGetUserInfo - Gets Information about user
- msiGetUserACL - Gets User ACL for all objects and collections
- msiCreateUserAccountsFromDataObj - Creates new user from information in an iRODS data object
- msiLoadUserModsFromDataObj - Modifies user information from information in an iRODS data object
- msiDeleteUsersFromDataObj - Deletes user from information in an iRODS data object
- msiLoadACLFromDataObj - Loads ACL from information in an iRODS data object
- msiGetAuditTrailInfoByUserID - Retrieves Audit Trail information for a user ID
- msiGetAuditTrailInfoByObjectID - Retrieves Audit Trail information for an object ID
- msiGetAuditTrailInfoByActionID - Retrieves Audit Trail information for a given action ID
- msiGetAuditTrailInfoByKeywords - Retrieves Audit Trail information by keywords in the comment field
- msiGetAuditTrailInfoByTimeStamp - Retrieves Audit Trail information by timestamp period
- msiSetDataType - Sets data type for an object
- msiGuessDataType - Guesses the data type of an object based on its file extension
- msiMergeDataCopies - Custom microservice for NARA consolidation rule
- msiFlagDataObjwithAVU - Flags a data object with an AVU
- msiGetCollectionContentsReport - Returns the number of objects in a collection by data type
- msiGetCollectionSize - Returns the object count and total disk usage of a collection
- msiGetObjectPath - Returns the path of an iRODS object
- msiCollectionSpider - Applies a microservice sequence to all data objects in a collection, recursively
- msiIsColl - Checks if an iRODS path is a collection. For use in workflows
- msiIsData - Checks if an iRODS path is a data object (an iRODS file). For use in workflows
- msiStructFileBundle - Bundles a collection for export
- msiFlagInfectedObjs - Parses output from clamscan and flags infected objects
- msiStoreVersionWithTS - Creates a timestamped backup version of an iRODS data object
- msiFtpGet - Gets a remote file using FTP and writes it to an iRODS object
- msiTwitterPost - Posts a message to twitter.com
- msiLoadMetadataFromXml - Loads AVU metadata from an XML file of AVU triplets
- msiXmlDocSchemaValidate - Validates an XML file against an XSD schema, both iRODS objects
- msiXsltApply - Returns the xml object after applying the xslt transformation, given an xml object and an xslt object
- msiobjget_dbo - Gets a DBO object
- msiobjput_dbo - Puts a DBO object
- msiobjget_http - Gets an HTTP/HTTPS/FTP object
- msiobjput_http - Puts an HTTP/HTTPS/FTP object
- msiobjget_irods - Gets an iRODS object
- msiobjput_irods - Puts an iRODS object
- msiobjget_slink - Gets an SLINK object
- msiobjput_slink - Puts an SLINK object
- msiobjget_srb - Gets an SRB object
- msiobjput_srb - Puts an SRB object
- msiobjget_test - Gets a test object
- msiobjput_test - Puts a test object
- msiobjget_z3950 - Gets a Z39.50 object
- msiobjput_z3950 - Puts a Z39.50 object
- msiImageConvert - Reads a source image file and write it out as a new image file in a chosen format
- msiImageGetProperties - Gets the properties of an image file
- msiImageScale - Reads a source image file, scale it up or down in size, and write it out as a new image file in a chosen format
- msiH5File_open - Opens an HDF file
- msiH5File_close - Closes an HDF file
- msiH5Dataset_read - Reads data from an HDF file
- msiH5Dataset_read_attribute - Reads data attribute from an HDF file
- msiH5Group_read_attribute - Reads attributes of a group in an HDF file
- msiPropertiesNew - Creates a new empty property list
- msiPropertiesClear - Clears a property list
- msiPropertiesClone - Clones a property list, returning a new property list
- msiPropertiesAdd - Adds a property and value to a property list. If the property is already in the list, its value is changed. Otherwise the property is added.
- msiPropertiesRemove - Removes a property from the list
- msiPropertiesGet - Gets the value of a property in a property list. The property list is left unmodified.
- msiPropertiesSet - Sets the value of a property in a property list. If the property is already in the list, its value is changed. Otherwise the property is added.
- msiPropertiesExists - Returns true (integer 1) if the keyword has a property value in the property list, and false (integer 0) otherwise. The property list is unmodified.
- msiPropertiesToString - Converts a property list into a string buffer. The property list is left unmodified.
- msiPropertiesFromString - Parses a string into a new property list. The existing property list, if any, is deleted.
- msiGetQuote - Returns stock quotation (delayed by web service) using web service provided by http://www.webserviceX.NET
- msiIp2location - Returns host name and other details given an ipaddress using web service provided by http://ws.fraudlabs.com/
- msiConvertCurrency - Returns conversion rate for currencies from one country to another using web service provided by http://www.webserviceX.NET/
- msiObjByName - Returns position and type of an astronomical object given a name from the NASA/IPAC Extragalactic Database (NED) using web service at http://voservices.net/NED/ws_v2_0/NED.asmx
- msiSdssImgCutout_GetJpeg - Returns an image buffer given a position and cutout from the SDSS Image Cut Out service using web service provided by http://skyserver.sdss.org
- msiz3950Submit - Retrieves a record from a Z39.50 server