Treasury Analytics Core
  • Home
  • API Reference
  • Examples
  • Credentials
  • Global Settings
  1. API Reference
  2. Scripts
  3. configure_db
  • Overview
    • Treasury Analytics Core
  • Credential Management
    • Secure Credential Management
    • Global Settings
  • Examples
    • Example Projects
  • API Reference
    • Function reference
    • Core Components
      • FinanceDataEngine
      • engine_factory
      • engine
      • database
      • cache
      • processor
      • analyzer
    • Configuration
      • settings
      • settings_factory
      • global_settings_manager
    • Utilities
      • credentials
      • dataframe_utils
      • setup_logging
      • env_checker
      • query_timer
      • setup_helper
      • logging
      • constants
      • types
    • Scripts
      • configure_db
      • create_project
      • manage_settings

On this page

  • configure_db
    • Functions
      • create_env_file
      • main

Other Formats

  • Github (GFM)
  1. API Reference
  2. Scripts
  3. configure_db

configure_db

scripts.configure_db

Command-line tool for configuring database credentials.

Functions

Name Description
create_env_file Create an environment file without password.
main Configure database credentials.

create_env_file

scripts.configure_db.create_env_file(path, host, port, db_name, username)

Create an environment file without password.

Parameters

Name Type Description Default
path Path Path to save the file required
host str Database host required
port int Database port required
db_name str Database name required
username str Database username required

main

scripts.configure_db.main()

Configure database credentials.

types
create_project
 
 
  • Built with [Quarto](https://quarto.org/) and [quartodoc](https://machow.github.io/quartodoc/)