clj-icat-direct.queries — org.cyverse/clj-icat-direct 2.9.4

mk-bad-file-cond clj

(mk-bad-file-cond parent-path bad-chars bad-names bad-paths)

Returns a WHERE condition for files in the count-bad-items-in-folder query.

Parameters: parent-path - the absolute path to the folder containing the files bad-chars - the characters a name cannot contain bad-names - the bad names bad-paths - the bad paths

Returns: It returns the condition.

mk-bad-folder-cond clj

(mk-bad-folder-cond parent-path bad-chars bad-names bad-paths)

Returns a WHERE condition for folders in the count-bad-items-in-folder query.

Parameters: parent-path - the absolute path to the folder containing the folders bad-chars - the characters a name cannot contain bad-names - the bad names bad-paths - the bad paths

Returns: It returns the condition.

mk-count-bad-files-in-folder clj

(mk-count-bad-files-in-folder &
                              {:keys [user zone parent-path info-type-cond
                                      bad-file-cond]})

This function constructs a query for counting all of the files that are direct members of a given folder, accessible to a given user, satisfy a given info type condition, and satisfy a given condition indicating the file has an invalid name.

Parameters: user - username of the user that can access the files zone - iRODS authentication zone of the user parent-path - the folder being inspected info-type-cond - a WHERE condition indicating the info types of the files to be counted bad-file-cond - a WHERE condition indicating that a file has an invalid name

Returns: It returns the properly formatted SELECT query.

mk-count-bad-folders-in-folder clj

(mk-count-bad-folders-in-folder &
                                {:keys [user zone parent-path bad-folder-cond]})

This function constructs a query for counting all of the folders that are direct members of a given folder, accessible to a given user, and satisfy a given condition indicating the folder has an invalid name.

Parameters: user - username of the user that can access the folders zone - iRODS authentication zone of the user parent-path - the folder being inspected bad-folder-cond - a WHERE condition indicating that a folder has an invalid name

Returns: It returns the properly formatted SELECT query.

mk-count-bad-items-in-folder clj

(mk-count-bad-items-in-folder &
                              {:keys [user zone parent-path info-type-cond
                                      bad-file-cond bad-folder-cond]})

This function constructs a query for counting all of the files and folders that are direct members of a given folder, accessible to a given user, satisfy a given info type condition, and satisfy a given condition indicating the file or folder has an invalid name.

Parameters: user - username of the user that can access the files and folders zone - iRODS authentication zone of the user parent-path - the folder being inspected info-type-cond - a WHERE condition indicating the info types of the files to be counted bad-file-cond - a WHERE condition indicating that a file has an invalid name bad-folder-cond - A WHERE condition indicating that a folder has an invalid name

Returns: It returns the properly formatted SELECT query.

mk-count-files-in-folder clj

(mk-count-files-in-folder user zone parent-path info-type-cond)

This function constructs a query for counting all of the files that are direct members of a given folder, accessible to a given user, and satisfy a given info type condition.

Parameters: user - username of the user that can access the files zone - iRODS authentication zone of the user parent-path - the folder being inspected info-type-cond - a WHERE condition indicating the info types of the files to be counted

Returns: It returns the properly formatted SELECT query.

mk-count-folders-in-folder clj

(mk-count-folders-in-folder user zone parent-path)

This function constructs a query for counting all of the folders that are direct members of a given folder and accessible to a given user.

Parameters: user - username of the user that can access the files zone - iRODS authentication zone of the user parent-path - the folder being inspected

Returns: It returns the properly formatted SELECT query.

mk-count-items-in-folder clj

(mk-count-items-in-folder user zone parent-path info-type-cond)

This function constructs a set of queries for counting all of the files and folders that are direct members of a given folder, accessible to a given user, and satisfy a given info type condition.

Parameters: user - username of the user that can access the files and folders zone - iRODS authentication zone of the user parent-path - the folder being inspected info-type-cond - a WHERE condition indicating the info types of the files to be counted

Returns: It returns the properly formatted SELECT query.

mk-count-uuids-of-file-type clj

(mk-count-uuids-of-file-type user zone uuids info-type-cond)

This function constructs a query for returning the number of given uuids that are either folders or are files satisfying the given info type WHERE condition.

Parameter: user - username of the user that can access the files and folders zone - iRODS authentication zone of the user uuids - a comma-separated list of uuids to count info-type-cond - a WHERE condition indicating the info types of the files to be counted

Returns: It returns the a single row containing a single 'total' column containing the total.

mk-file-type-cond clj

(mk-file-type-cond file-types)

This function constructs condition for search for files with a given file type.

Parameters: file-types - A list of file types used to filter on. A nil or empty list disables filtering.

Returns: It returns a condition for filtering data objects by file type.

mk-filtered-filenames-without-attr clj

(mk-filtered-filenames-without-attr uuid-prefix attr)

mk-get-item clj

(mk-get-item dirname basename group-ids-query)

mk-groups clj

(mk-groups user zone & placeholder-vec?)

mk-paged-files-in-folder clj

(mk-paged-files-in-folder &
                          {:keys [user zone parent-path info-type-cond
                                  sort-column sort-direction limit offset
                                  groups-table-query]})

This function constructs a parameterized set of queries for returning a sorted page of files that are direct members of a given folder, accessible to a given user, and satisfy a given info type condition.

Parameters: user - username of the user that can access the files zone - iRODS authentication zone of the user parent-path - the folder being inspected info-type-cond - a WHERE condition indicating the info types of the files to be counted sort-column - the result field to sort on: (type|modify_ts|create_ts|data_size|base_name|full_path) sort-direction - the direction of the sort limit & offset - limit and offset to pass to the query

Returns: It returns the properly formatted parameterized SELECT query. The query is parameterized over the page size and offset, respectively. The query will return a result set sorted by the provided sort column. Each row in the result set will have the following columns.

type           - 'dataobject'
uuid           - the file's UUID
full_path      - the absolute path to the file in iRODS
base_name      - the name of the file
info_type      - the info type of the file
data_size      - the size in bytes of the file
create_ts      - the iRODS timestamp string for when the file was created
modify_ts      - the iRODS timestamp string for when the file was last modified
access_type_id - the ICAT DB Id indicating the user's level of access to the file

mk-paged-folder clj

(mk-paged-folder &
                 {:keys [user zone parent-path info-type-cond sort-column
                         sort-direction limit offset groups-table-query]})

This function constructs a set of parameterized queries for returning a sorted page of files and folders that are direct members of a given folder, accessible to a given user, and satisfy a given info type condition.

Parameters: user - username of the user that can access the files and folders zone - iRODS authentication zone of the user parent-path - the folder being inspected info-type-cond - a WHERE condition indicating the info types of the files to be counted sort-column - the result field to sort on: (type|modify_ts|create_ts|data_size|base_name|full_path) sort-direction - the direction of the sort limit & offset - limit and offset to pass to the query

Returns: It returns the properly formatted parameterized SELECT query. The query is parameterized over the page size and offset, respectively. The query will return a result set sorted primary by entity type, and secondarily by the provided sort column. Each row in the result set will have the following columns.

type           - (collection|dataobject) collection indicates folder and dataobject indicates
                 file
uuid           - the file's or folder's UUID
full_path      - the absolute path to the file or folder in iRODS
base_name      - the name of the file or folder
info_type      - the info type of the file or NULL for a folder
data_size      - the size in bytes of the file or 0 for a folder
create_ts      - the iRODS timestamp string for when the file or folder was created
modify_ts      - the iRODS timestamp string for when the file or folder was last modified
access_type_id - the ICAT DB Id indicating the user's level of access to the file or folder
data_checksum  - nil for collections, the MD5 checksum of the file for data objects

mk-paged-folders-in-folder clj

(mk-paged-folders-in-folder &
                            {:keys [user zone parent-path sort-column
                                    sort-direction limit offset
                                    groups-table-query]})

This function constructs a parameterized set of queries for returning a sorted page of folders that are direct members of a given folder and accessible to a given user.

Parameters: user - username of the user that can access the folders zone - iRODS authentication zone of the user parent-path - the folder being inspected sort-column - the result field to sort on: (type|modify_ts|create_ts|data_size|base_name|full_path) sort-direction - the direction of the sort limit & offset - limit and offset to pass to the query

Returns: It returns the properly formatted parameterized SELECT query. The query is parameterized over the page size and offset, respectively. The query will return a result set sorted by the provided sort column. Each row in the result set will have the following columns.

type           - 'collection'
uuid           - the folder's UUID
full_path      - the absolute path to the folder in iRODS
base_name      - the name of the folder
info_type      - 'NULL'
data_size      - '0'
create_ts      - the iRODS timestamp string for when the folder was created
modify_ts      - the iRODS timestamp string for when the folder was last modified
access_type_id - the ICAT DB Id indicating the user's level of access to the folder
data_checksum  - nil for collections, the MD5 checksum of the file for data objects

mk-path-for-uuid clj

(mk-path-for-uuid uuid)

mk-paths-for-uuids clj

(mk-paths-for-uuids uuids)

mk-perms-for-item clj

(mk-perms-for-item path)

mk-user clj

(mk-user user zone)

prepare-text-set clj

(prepare-text-set values)

Given a set, it prepares the elements for injection into an SQL query. It returns a string containing the quoted values separated by commas.

queries clj

sort-columns clj

This is a mapping of API column keywords to fields in the response document.

sort-directions clj

This ia a mapping of API sort direction keywords to database sort direction strings.