rosetta.basic.database
index
(built-in)

Bindings for basic::database namespace

 
Modules
       
rosetta.basic.database.insert_statement_generator
rosetta.basic.database.schema_generator

 
Classes
       
rosetta.basic.resource_manager.ResourceLoader(builtins.object)
DatabaseSessionLoader
rosetta.basic.resource_manager.ResourceLoaderCreator(builtins.object)
DatabaseSessionLoaderCreator
rosetta.basic.resource_manager.ResourceOptions(builtins.object)
DatabaseSessionOptions
rosetta.basic.resource_manager.ResourceOptionsCreator(builtins.object)
DatabaseSessionOptionsCreator

 
class DatabaseSessionLoader(rosetta.basic.resource_manager.ResourceLoader)
    
Method resolution order:
DatabaseSessionLoader
rosetta.basic.resource_manager.ResourceLoader
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(handle) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.basic.database.DatabaseSessionLoader,  : rosetta.basic.database.DatabaseSessionLoader) -> rosetta.basic.database.DatabaseSessionLoader
default_options(...) from builtins.PyCapsule
default_options(rosetta.basic.database.DatabaseSessionLoader) -> rosetta.basic.resource_manager.ResourceOptions

 
class DatabaseSessionLoaderCreator(rosetta.basic.resource_manager.ResourceLoaderCreator)
    
Method resolution order:
DatabaseSessionLoaderCreator
rosetta.basic.resource_manager.ResourceLoaderCreator
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(handle) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.basic.database.DatabaseSessionLoaderCreator,  : rosetta.basic.database.DatabaseSessionLoaderCreator) -> rosetta.basic.database.DatabaseSessionLoaderCreator
create_resource_loader(...) from builtins.PyCapsule
create_resource_loader(rosetta.basic.database.DatabaseSessionLoaderCreator) -> rosetta.basic.resource_manager.ResourceLoader
loader_type(...) from builtins.PyCapsule
loader_type(rosetta.basic.database.DatabaseSessionLoaderCreator) -> str

 
class DatabaseSessionOptions(rosetta.basic.resource_manager.ResourceOptions)
    
Method resolution order:
DatabaseSessionOptions
rosetta.basic.resource_manager.ResourceOptions
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(*args, **kwargs)
Overloaded function.
 
1. __init__(handle) -> NoneType
 
2. __init__(self : handle, name : str) -> NoneType
 
3. __init__(handle, rosetta.basic.database.DatabaseSessionOptions) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.basic.database.DatabaseSessionOptions,  : rosetta.basic.database.DatabaseSessionOptions) -> rosetta.basic.database.DatabaseSessionOptions
database_session(...) from builtins.PyCapsule
database_session(rosetta.basic.database.DatabaseSessionOptions) -> utility::sql_database::session
parse_my_tag(...) from builtins.PyCapsule
parse_my_tag(self : rosetta.basic.database.DatabaseSessionOptions,  : utility::tag::Tag) -> NoneType
type(...) from builtins.PyCapsule
type(rosetta.basic.database.DatabaseSessionOptions) -> str

Methods inherited from rosetta.basic.resource_manager.ResourceOptions:
__str__(...) from builtins.PyCapsule
__str__(rosetta.basic.resource_manager.ResourceOptions) -> str
name(...) from builtins.PyCapsule
name(*args, **kwargs)
Overloaded function.
 
1. name(rosetta.basic.resource_manager.ResourceOptions) -> str
 
A name given to a particular ResourceOptions instance.
 This function allows for better error message delivery.
 
2. name(self : rosetta.basic.resource_manager.ResourceOptions, setting : str) -> NoneType
 
Set the name for this %ResoureOptions instance.

 
class DatabaseSessionOptionsCreator(rosetta.basic.resource_manager.ResourceOptionsCreator)
    
Method resolution order:
DatabaseSessionOptionsCreator
rosetta.basic.resource_manager.ResourceOptionsCreator
builtins.object

Methods defined here:
__init__(...) from builtins.PyCapsule
__init__(handle) -> NoneType
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
assign(...) from builtins.PyCapsule
assign(self : rosetta.basic.database.DatabaseSessionOptionsCreator,  : rosetta.basic.database.DatabaseSessionOptionsCreator) -> rosetta.basic.database.DatabaseSessionOptionsCreator
create_options(...) from builtins.PyCapsule
create_options(rosetta.basic.database.DatabaseSessionOptionsCreator) -> rosetta.basic.resource_manager.ResourceOptions
options_type(...) from builtins.PyCapsule
options_type(rosetta.basic.database.DatabaseSessionOptionsCreator) -> str

 
Functions
       
check_statement_sanity(...) method of builtins.PyCapsule instance
check_statement_sanity(sql : str) -> NoneType
db_partition_from_options(...) method of builtins.PyCapsule instance
db_partition_from_options(db_mode : rosetta.utility.sql_database.e) -> int
 
Returns partition identifer if in partitioned database mode, otherwise -1.
find_cache_file(...) method of builtins.PyCapsule instance
find_cache_file(cache_file : str, dir_only : bool) -> bool
 
Does cache file (absolute path) exist?
 if dir_only is true, will return true if the cache file could be created.
find_database_path(...) method of builtins.PyCapsule instance
find_database_path(*args, **kwargs)
Overloaded function.
 
1. find_database_path(dir : str, filename : str) -> str
 
Find a path to a file.
 
 Try various combinations to locate the specific file being requested by the user.
 (inspired by core::scoring::ScoreFunction::find_weights_file())
 
 dir like chemical/carbohydrates/linkage_conformers/
 
2. find_database_path(dir : str, filename : str, ext : str) -> str
 
Find a path to a file.
 
 Try various combinations to locate the specific file being requested by the user.
 (inspired by core::scoring::ScoreFunction::find_weights_file())
 
 dir like chemical/carbohydrates/linkage_conformers/
full_cache_name(...) method of builtins.PyCapsule instance
full_cache_name(short_name : str, source_file : str, for_writing : bool) -> str
 
Get the (absolute) path to a given cached file.
 If source_file is given, it's the full path to the source database file that's being cached.
 If for_writing is true, will only check that the given file would be creatable.
 Will return an empty string if it can't find a cache file.
full_name(...) method of builtins.PyCapsule instance
full_name(*args, **kwargs)
Overloaded function.
 
1. full_name(db_file : str) -> str
 
Full-path database file name
 
2. full_name(db_file : str, warn : bool) -> str
 
Full-path database file name
get_db_session(...) method of builtins.PyCapsule instance
get_db_session(*args, **kwargs)
Overloaded function.
 
1. get_db_session() -> rosetta.utility.sql_database.session
 
Aquire a database session using the command line options
 transaction type is set to standard
 
2. get_db_session(db_name : str) -> rosetta.utility.sql_database.session
 
Aquire a database session using the command line parameters
 For postgres databases, the pq_schema acts like a namespace in the
 database. Transaction type set to standard
 
3. get_db_session(db_name : str, pq_schema : str) -> rosetta.utility.sql_database.session
 
Aquire a database session using the command line parameters
 For postgres databases, the pq_schema acts like a namespace in the
 database. Transaction type set to standard
 
4. get_db_session(db_name : str, transaction_mode : rosetta.utility.sql_database.e, chunk_size : int) -> rosetta.utility.sql_database.session
 
Aquire a database session using the command line parameters
 For postgres databases, the pq_schema acts like a namespace in the
 database
 
5. get_db_session(db_name : str, transaction_mode : rosetta.utility.sql_database.e, chunk_size : int, pq_schema : str) -> rosetta.utility.sql_database.session
 
Aquire a database session using the command line parameters
 For postgres databases, the pq_schema acts like a namespace in the
 database
 
6. get_db_session(db_mode : rosetta.utility.sql_database.e, db_name : str) -> rosetta.utility.sql_database.session
 
7. get_db_session(db_mode : rosetta.utility.sql_database.e, db_name : str, pq_schema : str) -> rosetta.utility.sql_database.session
 
8. get_db_session(db_mode : rosetta.utility.sql_database.e, transaction_mode : rosetta.utility.sql_database.e, chunk_size : int, db_name : str) -> rosetta.utility.sql_database.session
 
Aquire a database session using the command line parameters
 For postgres databases, the pq_schema acts like a namespace in the
 database
 
9. get_db_session(db_mode : rosetta.utility.sql_database.e, transaction_mode : rosetta.utility.sql_database.e, chunk_size : int, db_name : str, pq_schema : str) -> rosetta.utility.sql_database.session
 
Aquire a database session using the command line parameters
 For postgres databases, the pq_schema acts like a namespace in the
 database
insert_or_ignore(...) method of builtins.PyCapsule instance
insert_or_ignore(table_name : str, column_names : rosetta.std.vector_std_string, values : rosetta.std.vector_std_string, db_session : rosetta.utility.sql_database.session) -> NoneType
make_compound_statement(...) method of builtins.PyCapsule instance
make_compound_statement(table_name : str, column_names : rosetta.std.vector_std_string, row_count : int) -> str
open(...) method of builtins.PyCapsule instance
open(*args, **kwargs)
Overloaded function.
 
1. open(db_stream : utility::io::izstream, db_file : str) -> bool
 
Open a database file on a provided stream
 
2. open(db_stream : utility::io::izstream, db_file : str, warn : bool) -> bool
 
Open a database file on a provided stream
parse_database_connection(...) method of builtins.PyCapsule instance
parse_database_connection(tag : utility::tag::Tag) -> rosetta.utility.sql_database.session
resolve_db_partition(...) method of builtins.PyCapsule instance
resolve_db_partition(*args, **kwargs)
Overloaded function.
 
1. resolve_db_partition(partition_by_mpi_process : bool) -> int
 
Returns partition identifer from mpi rank if in partitioned database mode, or valid manual partition, otherwise -1.
 
2. resolve_db_partition(partition_by_mpi_process : bool, manual_partition : int) -> int
 
Returns partition identifer from mpi rank if in partitioned database mode, or valid manual partition, otherwise -1.
safely_prepare_statement(...) method of builtins.PyCapsule instance
safely_prepare_statement(statement_string : str, db_session : rosetta.utility.sql_database.session) -> rosetta.cppdb.statement
safely_read_from_database(...) method of builtins.PyCapsule instance
safely_read_from_database(statement : rosetta.cppdb.statement) -> rosetta.cppdb.result
safely_write_to_database(...) method of builtins.PyCapsule instance
safely_write_to_database(statement : rosetta.cppdb.statement) -> NoneType
set_cache_size(...) method of builtins.PyCapsule instance
set_cache_size(db_session : rosetta.utility.sql_database.session, cache_size : int) -> NoneType
 
set the number of 1kb pages to use for cache
table_exists(...) method of builtins.PyCapsule instance
table_exists(db_session : rosetta.utility.sql_database.session, table_name : str) -> bool
write_schema_to_database(...) method of builtins.PyCapsule instance
write_schema_to_database(schema : str, db_session : rosetta.utility.sql_database.session) -> NoneType