irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

deploy_schemas_locally Namespace Reference

Functions

def get_script_directory ()
 
def makedirs_catch_preexisting (*args, **kwargs)
 
def is_schema_template (filename)
 
def update_schema_dict (schema_dict, url_base_with_version, filename)
 
def main (template_directory, output_directory_base, url_base)
 

Variables

string SCHEMA_VERSION = '3'
 
string usage
 
 parser = optparse.OptionParser(usage=usage)
 
 help
 
 metavar
 
 options
 
 _
 
 output_directory_base
 
 template_directory
 
 url_base
 

Function Documentation

◆ get_script_directory()

def deploy_schemas_locally.get_script_directory ( )

Definition at line 10 of file deploy_schemas_locally.py.

◆ is_schema_template()

def deploy_schemas_locally.is_schema_template (   filename)

Definition at line 21 of file deploy_schemas_locally.py.

Referenced by main().

◆ main()

def deploy_schemas_locally.main (   template_directory,
  output_directory_base,
  url_base 
)

Definition at line 27 of file deploy_schemas_locally.py.

References is_schema_template(), makedirs_catch_preexisting(), and update_schema_dict().

Here is the call graph for this function:

◆ makedirs_catch_preexisting()

def deploy_schemas_locally.makedirs_catch_preexisting ( args,
**  kwargs 
)

Definition at line 14 of file deploy_schemas_locally.py.

Referenced by main().

◆ update_schema_dict()

def deploy_schemas_locally.update_schema_dict (   schema_dict,
  url_base_with_version,
  filename 
)

Definition at line 24 of file deploy_schemas_locally.py.

Referenced by main().

Variable Documentation

◆ _

deploy_schemas_locally._
private

Definition at line 63 of file deploy_schemas_locally.py.

Referenced by rmdirCollUtil().

◆ help

deploy_schemas_locally.help

Definition at line 60 of file deploy_schemas_locally.py.

◆ metavar

deploy_schemas_locally.metavar

Definition at line 61 of file deploy_schemas_locally.py.

◆ options

deploy_schemas_locally.options

Definition at line 63 of file deploy_schemas_locally.py.

Referenced by parse_program_options(), and rmdirCollUtil().

◆ output_directory_base

deploy_schemas_locally.output_directory_base

Definition at line 68 of file deploy_schemas_locally.py.

◆ parser

deploy_schemas_locally.parser = optparse.OptionParser(usage=usage)

Definition at line 59 of file deploy_schemas_locally.py.

Referenced by _addChildToResource(), _childIsValid(), create_replication_list(), dataObjOpenForRepl(), db_del_child_resc_op(), deferred_redirect_for_operation(), irods.determine_force_write_to_new_resource(), irods::resource_manager.gather_operations_recursive(), get_next_child(), get_next_child_for_open_or_write(), irods.get_resc_hier_property(), getDataObjInfo(), getPhyPath(), irods::hierarchy_parser.hierarchy_parser(), impostor_file_resolve_hierarchy_open(), irsPhyPathReg(), irods.is_hier_live(), load_balanced_redirect_for_create_operation(), load_balanced_redirect_for_open_operation(), mock_archive_redirect_open(), non_blocking_file_redirect_open(), repl_file_close(), repl_file_closedir(), repl_file_create(), repl_file_getfs_freespace(), repl_file_lseek(), repl_file_mkdir(), repl_file_modified(), repl_file_notify(), repl_file_open(), repl_file_opendir(), repl_file_read(), repl_file_readdir(), repl_file_registered(), repl_file_rename(), repl_file_rmdir(), repl_file_stage_to_cache(), repl_file_stat(), repl_file_sync_to_arch(), repl_file_truncate(), repl_file_unlink(), repl_file_unregistered(), repl_file_write(), repl_object(), irods.request_vote_for_file_object(), resolve_children(), irods.resolve_hier_for_create_or_open(), irods.resolve_hier_for_open_or_write(), irods.resolve_hier_for_open_or_write_without_keyword(), resolve_hierarchy_for_resc_from_cond_input(), rsDataObjCreate(), select_child(), structFileReg(), structFileSupport(), tar_struct_file_open(), trimDataObjInfo(), univ_mss_file_resolve_hierarchy_open(), unix_resolve_hierarchy_open(), and updatequotaOverrun().

◆ SCHEMA_VERSION

string deploy_schemas_locally.SCHEMA_VERSION = '3'

Definition at line 8 of file deploy_schemas_locally.py.

◆ template_directory

deploy_schemas_locally.template_directory

Definition at line 71 of file deploy_schemas_locally.py.

◆ url_base

deploy_schemas_locally.url_base

Definition at line 74 of file deploy_schemas_locally.py.

◆ usage

string deploy_schemas_locally.usage
Initial value:
1 = '''\
2 Usage: python %prog --output_directory_base <path to desired deployment directory> [options]
3 
4  Deploys packaged schemas to <output_directory_base>.
5 
6  Sets "id" field of deployed schemas appropriately based on <url_base>.
7 
8  Example usage:
9 
10  python %prog --output_directory_base /tmp/irods_schemas
11 
12  This will create, if necessary, /tmp/irods_schemas and /tmp/irods_schemas/v{SCHEMA_VERSION}, then populate the latter with copies of the schema files currently found in {SCHEMAS_DIR}. The schema copies will have their "id" fields updated to reflect their new locations (e.g. "server_config.json" will have "id" field "file:///tmp/irods_schemas/v{SCHEMA_VERSION}/server_config.json#".
13 
14  To have an iRODS installation validate its configuration files against this local deployment, set the iRODS "schema_validation_base_uri" (found in "/etc/irods/server_config.json" or fed into the prompt during setup) to "file:///tmp/irods_schemas".
15 
16  Make sure that the Linux account running iRODS has read access to the deployed schemas.
17 '''.format(SCHEMA_VERSION=SCHEMA_VERSION, SCHEMAS_DIR=os.path.join(get_script_directory(), 'schemas'))

Definition at line 41 of file deploy_schemas_locally.py.

deploy_schemas_locally.get_script_directory
def get_script_directory()
Definition: deploy_schemas_locally.py:10