🔍 Code Extractor

Retrieves the default database connection configuration by loading settings from a sql_config.py file located in the same directory as the function.

Purpose

This function provides a centralized way to obtain default database connection settings without requiring manual configuration. It locates the sql_config.py file relative to the function's location and uses the ConnectionConfig class to parse and return the configuration. This is useful for establishing database connections with predefined settings across an application.

Source Code

def get_default_connection_config() -> ConnectionConfig:
    """Get default connection configuration from sql_config.py"""
    import os
    config_path = os.path.join(os.path.dirname(__file__), 'sql_config.py')
    return ConnectionConfig.from_config_file(config_path)

Return Value

Type: ConnectionConfig

Returns a ConnectionConfig object containing database connection parameters such as host, port, username, password, database name, and other connection settings parsed from the sql_config.py file. The exact structure depends on the ConnectionConfig class implementation.

Dependencies

• os
• pathlib
• json
• logging
• typing
• dataclasses
• urllib.parse
• importlib.util
• re
• datetime

Required Imports

import os
from typing import Dict, List, Optional, Any, Tuple
from dataclasses import dataclass
from pathlib import Path
from column_mapping import COLUMN_MAPPING, RECOMMENDED_JOINS, PROBLEMATIC_TABLES, RECOMMENDED_RESULT_TABLES
from datetime import datetime
from urllib.parse import quote_plus
import importlib.util
import re
import json
import logging

Usage Example

# Assuming ConnectionConfig class is available in the module
# and sql_config.py exists in the same directory

from your_module import get_default_connection_config

# Get the default connection configuration
config = get_default_connection_config()

# Use the configuration to establish a database connection
# Example (actual usage depends on ConnectionConfig implementation):
# connection = create_connection(config)
# cursor = connection.cursor()
# cursor.execute('SELECT * FROM users')

Best Practices

• Ensure sql_config.py exists in the same directory before calling this function, or handle potential FileNotFoundError exceptions
• The sql_config.py file should contain sensitive information like passwords, so ensure it's properly secured and not committed to version control
• Consider using environment variables or secure vaults for production environments instead of hardcoded configuration files
• The function uses __file__ to determine the directory, which may not work correctly in certain execution contexts (e.g., frozen executables)
• Validate the returned ConnectionConfig object before using it to establish database connections
• This function has no error handling, so wrap calls in try-except blocks to handle missing files or invalid configurations gracefully

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• function load_connection_config 69.4% similar

  Loads database connection configuration from a specified configuration file and returns a ConnectionConfig object.

  From: /tf/active/vicechatdev/full_smartstat/sql_query_generator.py

• class ConnectionConfig 66.7% similar

  A dataclass that stores and manages database connection configuration parameters for SQL Server connections, providing methods to load from config files and generate connection strings.

  From: /tf/active/vicechatdev/full_smartstat/sql_query_generator.py

• function get_default_schema_file 57.3% similar

  Returns the absolute file path to the default database schema JSON file (database_schema_20251003_120434.json) located in the same directory as the function.

  From: /tf/active/vicechatdev/full_smartstat/sql_query_generator.py

• function get_system_settings 55.7% similar

  Retrieves system-wide configuration settings from a Neo4j database, returning default values if settings are not found or an error occurs.

  From: /tf/active/vicechatdev/CDocs/controllers/admin_controller.py

• function get_default_schema_file_v1 51.7% similar

  Returns the absolute file path to the default database schema JSON file (Poulpharm_labosoft.json) located in the same directory as the function's module.

  From: /tf/active/vicechatdev/smartstat/sql_query_generator.py