rabbit-bq-job-optimizer 0.1.6

Python client for Rabbit BigQuery Job Optimizer API

Rabbit BigQuery Job Optimizer Python Client

This is the official Python client library for the Rabbit BigQuery Job Optimizer API.

Installation

pip install rabbit-bq-job-optimizer

Usage

from rabbit_bq_job_optimizer import RabbitBQOptimizer, OptimizationConfig

# Initialize the client
client = RabbitBQOptimizer(
    api_key="your-api-key",
    base_url="https://api.rabbit.com/v1"  
)

# Optimize a BigQuery job configuration
job_config = {
    "configuration": {
        "query": {
            "query": "SELECT * FROM my_table",
            "useLegacySql": False,
            "priority": "INTERACTIVE"
        }
    }
}

optimization_config = OptimizationConfig(
    type="reservation_assignment",
    config={
        "defaultPricingMode": "on_demand",
        "reservationIds": [
            "my-project:US.my-reservation-us",
            "my-project:EU.my-reservation-eu"
        ]
    }
)

# Optimize the job
result = client.optimize_job(
    configuration=job_config,
    enabledOptimizations=[optimization_config]
)

# Access the optimized configuration
optimized_config = result.optimizedJob

# Access optimization results
for optimization in result.optimizationResults:
    print(f"Type: {optimization.type}")
    print(f"Applied: {optimization.performed}")
    print(f"Estimated Savings: {optimization.estimatedSavings}")

Error Handling

The client raises exceptions for API errors:

from rabbit_bq_job_optimizer import RabbitBQOptimizerError

try:
    result = client.optimize_job(job_config)
except RabbitBQOptimizerError as e:
    print(f"Error: {e.message}")
    print(f"Status Code: {e.status_code}")

Authentication

The API key and base URL are required to use the client. These can be obtained from the Rabbit team by contacting [e-mail].

There are two ways to configure authentication:

1. Pass directly to the constructor:

from rabbit_bq_job_optimizer import RabbitBQOptimizer

client = RabbitBQOptimizer(
    api_key="your-api-key",
    base_url="your-base-url"
)

2. Set environment variables:

export RABBIT_API_KEY="your-api-key"
export RABBIT_API_BASE_URL="your-base-url"

Then initialize the client without parameters:

from rabbit_bq_job_optimizer import RabbitBQOptimizer

client = RabbitBQOptimizer()  # Will automatically use environment variables

The environment variables are:

• RABBIT_API_KEY: Your Rabbit API key
• RABBIT_API_BASE_URL: The base URL for the Rabbit API

Development

To install the package in development mode:

pip install -e .

License

Apache License 2.0