dbtk
Contents:
Getting Started with DBTK
Configuration & Security
Database Connections
Record Objects
File Readers
Data Writers
Excel Reports
ETL: Table, Transforms & Lookups
ETL: DataSurge & BulkSurge
ETL: Tools & Logging
Advanced Features & Performance
Troubleshooting Guide
API Reference
dbtk
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
_
__init__() (dbtk.config.ConfigManager method)
(dbtk.cursors.Cursor method)
(dbtk.cursors.PreparedStatement method)
(dbtk.database.Database method)
(dbtk.etl.BulkSurge method)
(dbtk.etl.DataSurge method)
(dbtk.etl.managers.IdentityManager method)
(dbtk.etl.managers.ValidationCollector method)
(dbtk.etl.QueryLookup method)
(dbtk.etl.Table method)
(dbtk.etl.TableLookup method)
(dbtk.etl.transforms.TableLookup method)
(dbtk.logging_utils.ErrorCountHandler method)
(dbtk.readers.base.Reader method)
(dbtk.readers.csv.CSVReader method)
(dbtk.readers.data_frame.DataFrameReader method)
(dbtk.readers.excel.ExcelReader method)
(dbtk.readers.excel.XLSReader method)
(dbtk.readers.fixed_width.EDIReader method)
(dbtk.readers.fixed_width.FixedReader method)
(dbtk.readers.json.JSONReader method)
(dbtk.readers.json.NDJSONReader method)
(dbtk.readers.xml.XMLColumn method)
(dbtk.readers.xml.XMLReader method)
(dbtk.record.Record method)
(dbtk.utils.ErrorDetail method)
(dbtk.utils.FixedColumn method)
(dbtk.utils.QueryLogger method)
(dbtk.writers.base.BaseWriter method)
(dbtk.writers.base.BatchWriter method)
(dbtk.writers.csv.CSVWriter method)
(dbtk.writers.database.DatabaseWriter method)
(dbtk.writers.excel.ColumnRule method)
(dbtk.writers.excel.ExcelFormat method)
(dbtk.writers.excel.ExcelWriter method)
(dbtk.writers.excel.LinkedExcelWriter method)
(dbtk.writers.excel.LinkSource method)
(dbtk.writers.fixed_width.EDIWriter method)
(dbtk.writers.fixed_width.FixedWidthWriter method)
(dbtk.writers.json.JSONWriter method)
(dbtk.writers.json.NDJSONWriter method)
(dbtk.writers.xml.XMLStreamer method)
(dbtk.writers.xml.XMLWriter method)
_records (dbtk.writers.excel.LinkSource attribute)
A
accepts_file_handle (dbtk.writers.base.BaseWriter attribute)
(dbtk.writers.base.BatchWriter attribute)
(dbtk.writers.excel.ExcelWriter attribute)
(dbtk.writers.fixed_width.EDIWriter attribute)
(dbtk.writers.fixed_width.FixedWidthWriter attribute)
add_error() (dbtk.etl.managers.IdentityManager method)
add_filter() (dbtk.readers.base.Reader method)
add_message() (dbtk.etl.managers.IdentityManager method)
add_password() (dbtk.config.ConfigManager method)
add_row_num (dbtk.readers.fixed_width.FixedReader attribute)
added (dbtk.etl.managers.ValidationCollector attribute)
auto_trim (dbtk.readers.fixed_width.FixedReader attribute)
B
BaseWriter (class in dbtk.writers.base)
batch_iterable() (in module dbtk.utils)
batch_resolve() (dbtk.etl.managers.IdentityManager method)
BatchWriter (class in dbtk.writers.base)
BIG_BYTE_THRESHOLD (dbtk.readers.base.Reader attribute)
BIG_ROW_THRESHOLD (dbtk.readers.base.Reader attribute)
bind() (dbtk.etl.QueryLookup method)
bind_name_column() (dbtk.etl.Table method)
BulkSurge (class in dbtk.etl)
C
CACHE_LAZY (dbtk.etl.TableLookup attribute)
(dbtk.etl.transforms.TableLookup attribute)
CACHE_NONE (dbtk.etl.TableLookup attribute)
(dbtk.etl.transforms.TableLookup attribute)
CACHE_PRELOAD (dbtk.etl.TableLookup attribute)
(dbtk.etl.transforms.TableLookup attribute)
cache_record() (dbtk.writers.excel.LinkSource method)
calc_stats() (dbtk.etl.managers.IdentityManager method)
calc_update_excludes() (dbtk.etl.Table method)
capitalize() (in module dbtk.etl.transforms)
check_dependencies() (in module dbtk.readers.excel)
(in module dbtk.writers.excel)
(in module dbtk.writers.xml)
checkup() (in module dbtk.cli)
cleanup_old_logs() (in module dbtk.logging_utils)
close() (dbtk.writers.base.BaseWriter method)
(dbtk.writers.excel.ExcelWriter method)
coalesce() (dbtk.record.Record method)
(in module dbtk.etl.transforms)
code (dbtk.utils.ErrorDetail attribute)
,
[1]
collect_new() (dbtk.etl.managers.ValidationCollector method)
column_defs_from_db() (in module dbtk.etl)
ColumnRule (class in dbtk.writers.excel)
columns (dbtk.etl.Table property)
(dbtk.readers.fixed_width.FixedReader attribute)
(dbtk.readers.xml.XMLReader property)
(dbtk.writers.base.BaseWriter attribute)
columns() (dbtk.cursors.Cursor method)
config (dbtk.config.ConfigManager attribute)
config_file (dbtk.config.ConfigManager attribute)
ConfigManager (class in dbtk.config)
connect() (in module dbtk.config)
connection (dbtk.cursors.Cursor attribute)
copy() (dbtk.record.Record method)
counts (dbtk.etl.Table attribute)
create() (dbtk.database.Database class method)
CSVReader (class in dbtk.readers.csv)
CSVWriter (class in dbtk.writers.csv)
Cursor (class in dbtk.cursors)
cursor (dbtk.etl.Table property)
(dbtk.etl.TableLookup property)
(dbtk.etl.transforms.TableLookup property)
cursor() (dbtk.database.Database method)
cursor_to_cursor() (in module dbtk.writers.database)
D
data_iterator (dbtk.writers.base.BaseWriter attribute)
(dbtk.writers.base.BatchWriter attribute)
Database (class in dbtk.database)
database_name (dbtk.database.Database attribute)
database_type (dbtk.database.Database attribute)
DatabaseWriter (class in dbtk.writers.database)
DataFrameReader (class in dbtk.readers.data_frame)
DataSurge (class in dbtk.etl)
db_expr_cols() (dbtk.etl.Table method)
dbtk.cli
module
dbtk.config
module
dbtk.cursors
module
dbtk.database
module
dbtk.etl
module
dbtk.etl.managers
module
dbtk.etl.transforms
module
dbtk.formats.edi
module
dbtk.logging_utils
module
dbtk.readers.base
module
dbtk.readers.csv
module
dbtk.readers.data_frame
module
dbtk.readers.excel
module
dbtk.readers.fixed_width
module
dbtk.readers.json
module
dbtk.readers.xml
module
dbtk.record
module
dbtk.utils
module
dbtk.writers.base
module
dbtk.writers.csv
module
dbtk.writers.database
module
dbtk.writers.excel
module
dbtk.writers.fixed_width
module
dbtk.writers.json
module
dbtk.writers.xml
module
decrypt_password() (dbtk.config.ConfigManager method)
DEFAULT (dbtk.utils.ParamStyle attribute)
delete() (dbtk.etl.DataSurge method)
description (dbtk.cursors.Cursor attribute)
diagnose_config() (in module dbtk.config)
dialect (dbtk.database.Database property)
driver (dbtk.database.Database attribute)
dump() (dbtk.etl.BulkSurge method)
dump_path (dbtk.etl.BulkSurge attribute)
E
EDIReader (class in dbtk.readers.fixed_width)
EDIWriter (class in dbtk.writers.fixed_width)
email_clean() (in module dbtk.etl.transforms)
email_validate() (in module dbtk.etl.transforms)
emit() (dbtk.logging_utils.ErrorCountHandler method)
encrypt_config_file() (in module dbtk.config)
encrypt_password() (dbtk.config.ConfigManager method)
(in module dbtk.config)
entities (dbtk.etl.managers.IdentityManager attribute)
,
[1]
EntityStatus (class in dbtk.etl.managers)
ERROR (dbtk.etl.managers.EntityStatus attribute)
,
[1]
ErrorCountHandler (class in dbtk.logging_utils)
ErrorDetail (class in dbtk.utils)
errors_logged() (in module dbtk.logging_utils)
ExcelFormat (class in dbtk.writers.excel)
ExcelReader (class in dbtk.readers.excel)
ExcelWriter (class in dbtk.writers.excel)
execute() (dbtk.cursors.Cursor method)
(dbtk.cursors.PreparedStatement method)
(dbtk.etl.Table method)
execute_file() (dbtk.cursors.Cursor method)
executemany() (dbtk.cursors.Cursor method)
exhaustive (dbtk.etl.transforms.TableLookup attribute)
existing (dbtk.etl.managers.ValidationCollector attribute)
F
fetch() (dbtk.etl.Table method)
fetchall() (dbtk.cursors.Cursor method)
fetchmany() (dbtk.cursors.Cursor method)
fetchone() (dbtk.cursors.Cursor method)
field (dbtk.utils.ErrorDetail attribute)
,
[1]
fieldnames (dbtk.readers.base.Reader property)
fixed_record_factory() (in module dbtk.record)
FixedColumn (class in dbtk.utils)
FixedReader (class in dbtk.readers.fixed_width)
FixedWidthRecord (class in dbtk.record)
FixedWidthWriter (class in dbtk.writers.fixed_width)
fn_resolver() (in module dbtk.etl.transforms)
force_positional() (dbtk.etl.Table method)
FORMAT (dbtk.utils.ParamStyle attribute)
format_digits() (in module dbtk.etl.transforms)
fp (dbtk.readers.fixed_width.FixedReader attribute)
from_line() (dbtk.record.FixedWidthRecord class method)
G
generate_encryption_key() (in module dbtk.config)
generate_link_from_row() (dbtk.writers.excel.LinkSource method)
get() (dbtk.record.Record method)
get_all() (dbtk.etl.managers.ValidationCollector method)
get_all_mapping() (dbtk.etl.managers.ValidationCollector method)
get_bind_params() (dbtk.etl.Table method)
get_bool() (in module dbtk.etl.transforms)
get_column_definitions() (dbtk.etl.Table method)
get_connection_config() (dbtk.config.ConfigManager method)
get_digits() (in module dbtk.etl.transforms)
get_float() (in module dbtk.etl.transforms)
get_id() (dbtk.etl.managers.IdentityManager method)
get_int() (in module dbtk.etl.transforms)
get_link() (dbtk.writers.excel.LinkSource method)
get_password() (dbtk.config.ConfigManager method)
(in module dbtk.config)
get_placeholder() (dbtk.utils.ParamStyle class method)
(dbtk.utils.ParamStyle method)
get_positional_style() (dbtk.utils.ParamStyle class method)
get_setting() (dbtk.config.ConfigManager method)
(in module dbtk.config)
get_sheet_by_index() (in module dbtk.readers.excel)
get_sheet_by_name() (in module dbtk.readers.excel)
get_sql() (dbtk.etl.DataSurge method)
(dbtk.etl.Table method)
get_supported_db_types() (in module dbtk.database)
get_valid_mapping() (dbtk.etl.managers.ValidationCollector method)
H
headers (dbtk.readers.base.Reader property)
I
identifier_needs_quoting() (in module dbtk.utils)
IdentityManager (class in dbtk.etl.managers)
indicator() (in module dbtk.etl.transforms)
insert() (dbtk.etl.DataSurge method)
(dbtk.record.Record method)
is_ready() (dbtk.etl.Table method)
items() (dbtk.record.Record method)
J
JSONReader (class in dbtk.readers.json)
JSONWriter (class in dbtk.writers.json)
K
key_cols (dbtk.etl.Table property)
keys() (dbtk.record.Record method)
L
last_error (dbtk.etl.Table attribute)
link_sources (dbtk.writers.excel.LinkedExcelWriter attribute)
LinkedExcelWriter (class in dbtk.writers.excel)
LinkSource (class in dbtk.writers.excel)
list_connections() (dbtk.config.ConfigManager method)
list_passwords() (dbtk.config.ConfigManager method)
load() (dbtk.etl.BulkSurge method)
(dbtk.etl.DataSurge method)
load_state() (dbtk.etl.managers.IdentityManager class method)
Lookup() (in module dbtk.etl)
(in module dbtk.etl.transforms)
M
main() (in module dbtk.cli)
max_display_width (dbtk.writers.excel.LinkSource property)
merge() (dbtk.etl.DataSurge method)
message (dbtk.utils.ErrorDetail attribute)
,
[1]
migrate_config() (in module dbtk.config)
module
dbtk.cli
dbtk.config
dbtk.cursors
dbtk.database
dbtk.etl
dbtk.etl.managers
dbtk.etl.transforms
dbtk.formats.edi
dbtk.logging_utils
dbtk.readers.base
dbtk.readers.csv
dbtk.readers.data_frame
dbtk.readers.excel
dbtk.readers.fixed_width
dbtk.readers.json
dbtk.readers.xml
dbtk.record
dbtk.utils
dbtk.writers.base
dbtk.writers.csv
dbtk.writers.database
dbtk.writers.excel
dbtk.writers.fixed_width
dbtk.writers.json
dbtk.writers.xml
mysql() (in module dbtk.database)
N
n_rows (dbtk.readers.fixed_width.FixedReader attribute)
name (dbtk.etl.Table property)
NAMED (dbtk.utils.ParamStyle attribute)
named_styles() (dbtk.utils.ParamStyle class method)
(dbtk.utils.ParamStyle method)
NDJSONReader (class in dbtk.readers.json)
NDJSONWriter (class in dbtk.writers.json)
normalize_field_name() (in module dbtk.utils)
normalize_whitespace() (in module dbtk.etl.transforms)
NOT_FOUND (dbtk.etl.managers.EntityStatus attribute)
,
[1]
null_values (dbtk.readers.fixed_width.FixedReader attribute)
NUMERIC (dbtk.utils.ParamStyle attribute)
O
open_workbook() (in module dbtk.readers.excel)
open_xml() (in module dbtk.readers.xml)
OPERATIONS (dbtk.etl.Table attribute)
oracle() (in module dbtk.database)
P
param_config (dbtk.etl.Table property)
param_help() (dbtk.database.Database method)
ParamStyle (class in dbtk.utils)
paramstyle (dbtk.cursors.Cursor attribute)
(dbtk.etl.Table property)
parse_date() (in module dbtk.etl.transforms)
parse_datetime() (in module dbtk.etl.transforms)
PENDING (dbtk.etl.managers.EntityStatus attribute)
,
[1]
phone_clean() (in module dbtk.etl.transforms)
phone_validate() (in module dbtk.etl.transforms)
placeholder (dbtk.cursors.Cursor attribute)
(dbtk.database.Database attribute)
pop() (dbtk.record.Record method)
positional_styles() (dbtk.utils.ParamStyle class method)
(dbtk.utils.ParamStyle method)
postgres() (in module dbtk.database)
pprint() (dbtk.record.FixedWidthRecord method)
(dbtk.record.Record method)
prepare_file() (dbtk.cursors.Cursor method)
prepare_params() (dbtk.cursors.Cursor method)
prepare_query() (dbtk.cursors.Cursor method)
PreparedStatement (class in dbtk.cursors)
preserve_types (dbtk.writers.base.BaseWriter attribute)
(dbtk.writers.base.BatchWriter attribute)
(dbtk.writers.excel.ExcelWriter attribute)
(dbtk.writers.fixed_width.EDIWriter attribute)
(dbtk.writers.fixed_width.FixedWidthWriter attribute)
(dbtk.writers.xml.XMLWriter attribute)
process_sql_parameters() (in module dbtk.utils)
PYFORMAT (dbtk.utils.ParamStyle attribute)
Q
QMARK (dbtk.utils.ParamStyle attribute)
QueryLogger (class in dbtk.utils)
QueryLookup (class in dbtk.etl)
quote_identifier() (in module dbtk.utils)
R
Reader (class in dbtk.readers.base)
Record (class in dbtk.record)
record_count (dbtk.readers.json.JSONReader property)
(dbtk.readers.xml.XMLReader property)
refresh_readiness() (dbtk.etl.Table method)
register_link_source() (dbtk.writers.excel.LinkedExcelWriter method)
register_user_drivers() (in module dbtk.database)
remove_password() (dbtk.config.ConfigManager method)
req_cols (dbtk.etl.Table property)
reqs_met() (dbtk.etl.Table method)
reqs_missing() (dbtk.etl.Table method)
reset_format_cache() (in module dbtk.utils)
resolve() (dbtk.etl.managers.IdentityManager method)
RESOLVED (dbtk.etl.managers.EntityStatus attribute)
,
[1]
resolver (dbtk.etl.managers.IdentityManager property)
reverse() (dbtk.record.Record method)
row_count (dbtk.etl.Table property)
(dbtk.readers.base.Reader property)
(dbtk.writers.base.BaseWriter property)
S
sanitize_identifier() (in module dbtk.utils)
save_state() (dbtk.etl.managers.IdentityManager method)
selectinto() (dbtk.cursors.Cursor method)
set_config_file() (in module dbtk.config)
set_fields() (dbtk.record.FixedWidthRecord class method)
(dbtk.record.Record class method)
set_id() (dbtk.etl.managers.IdentityManager method)
set_setting() (dbtk.config.ConfigManager method)
set_values() (dbtk.etl.Table method)
setup_config() (in module dbtk.config)
setup_logging() (in module dbtk.logging_utils)
skip_details (dbtk.etl.BulkSurge attribute)
(dbtk.etl.DataSurge attribute)
skip_rows (dbtk.readers.fixed_width.FixedReader attribute)
skipped (dbtk.etl.BulkSurge attribute)
(dbtk.etl.DataSurge attribute)
SKIPPED (dbtk.etl.managers.EntityStatus attribute)
,
[1]
sort() (dbtk.record.Record method)
source (dbtk.readers.base.Reader property)
split_and_get() (in module dbtk.etl.transforms)
sqlite() (in module dbtk.database)
sqlserver() (in module dbtk.database)
STAGED (dbtk.etl.managers.EntityStatus attribute)
,
[1]
standardize_address() (in module dbtk.etl.transforms)
store_key() (in module dbtk.config)
T
Table (class in dbtk.etl)
TableLookup (class in dbtk.etl)
(class in dbtk.etl.transforms)
to_csv() (in module dbtk.writers.csv)
to_dict() (dbtk.record.Record method)
(dbtk.writers.excel.ColumnRule method)
(dbtk.writers.excel.ExcelFormat method)
to_edi() (in module dbtk.writers.fixed_width)
to_excel() (in module dbtk.writers.excel)
to_fixed_width() (in module dbtk.writers.fixed_width)
to_json() (in module dbtk.writers.json)
to_line() (dbtk.record.FixedWidthRecord method)
to_ndjson() (in module dbtk.writers.json)
to_number() (in module dbtk.etl.transforms)
to_string() (dbtk.writers.base.BaseWriter method)
(dbtk.writers.csv.CSVWriter method)
(dbtk.writers.json.JSONWriter method)
(dbtk.writers.json.NDJSONWriter method)
(in module dbtk.utils)
to_xml() (in module dbtk.writers.xml)
total (dbtk.readers.data_frame.DataFrameReader property)
total_loaded (dbtk.etl.BulkSurge attribute)
(dbtk.etl.DataSurge attribute)
total_read (dbtk.etl.BulkSurge attribute)
(dbtk.etl.DataSurge attribute)
transaction() (dbtk.database.Database method)
U
update() (dbtk.etl.DataSurge method)
(dbtk.record.Record method)
V
Validate() (in module dbtk.etl)
(in module dbtk.etl.transforms)
validate_identifier() (in module dbtk.utils)
validate_us_address() (in module dbtk.etl.transforms)
ValidationCollector (class in dbtk.etl.managers)
VALUES (dbtk.etl.managers.EntityStatus attribute)
values (dbtk.etl.Table attribute)
values() (dbtk.record.Record method)
(dbtk.utils.ParamStyle class method)
(dbtk.utils.ParamStyle method)
visualize() (dbtk.readers.fixed_width.EDIReader method)
(dbtk.readers.fixed_width.FixedReader method)
(dbtk.record.FixedWidthRecord method)
W
width (dbtk.utils.FixedColumn property)
wrap_at_comma() (in module dbtk.utils)
WRAPPER_SETTINGS (dbtk.cursors.Cursor attribute)
write() (dbtk.writers.base.BaseWriter method)
(dbtk.writers.base.BatchWriter method)
(dbtk.writers.database.DatabaseWriter method)
write_batch() (dbtk.writers.base.BatchWriter method)
(dbtk.writers.excel.ExcelWriter method)
(dbtk.writers.excel.LinkedExcelWriter method)
X
XLSReader (class in dbtk.readers.excel)
XMLColumn (class in dbtk.readers.xml)
XMLReader (class in dbtk.readers.xml)
XMLStreamer (class in dbtk.writers.xml)
XMLWriter (class in dbtk.writers.xml)