airqo-platform / AirQo-api

This repo contains API definitions for the AirQo platform
MIT License
22 stars 20 forks source link

Fix get_devices_hourly_data query #3230

Closed MartinKalema closed 3 months ago

MartinKalema commented 3 months ago

WHAT DOES THIS PR DO? This PR fixes an SQL query used to retrieve device data by adding backticks around table and column names to avoid syntax errors. This change ensures that the SQL parser correctly interprets identifiers, especially those with periods and special characters.

CHANGES MADE:

  1. Modified the SQL query:

    • Added backticks around the table and column names in the get_devices_hourly_data function to prevent syntax errors.

    Before:

    query = (
        f"SELECT {self.hourly_measurements_table}.pm2_5_calibrated_value, "
        f"{self.hourly_measurements_table}.pm2_5_raw_value, "
        f"{self.hourly_measurements_table}.site_id, "
        f"{self.hourly_measurements_table}.device_id AS device, "
        f"FORMAT_DATETIME('%Y-%m-%d %H:%M:%S', {self.hourly_measurements_table}.timestamp) AS timestamp "
        f"FROM {self.hourly_measurements_table} "
        f"WHERE DATE({self.hourly_measurements_table}.timestamp) >= '{day.strftime('%Y-%m-%d')}' "
        f"AND {self.hourly_measurements_table}.pm2_5_raw_value IS NOT NULL "
    )

    After:

    query = (
        f"SELECT `{self.hourly_measurements_table}`.pm2_5_calibrated_value, "
        f"`{self.hourly_measurements_table}`.pm2_5_raw_value, "
        f"`{self.hourly_measurements_table}`.site_id, "
        f"`{self.hourly_measurements_table}`.device_id AS device, "
        f"FORMAT_DATETIME('%Y-%m-%d %H:%M:%S', `{self.hourly_measurements_table}`.timestamp) AS timestamp "
        f"FROM `{self.hourly_measurements_table}` "
        f"WHERE DATE(`{self.hourly_measurements_table}`.timestamp) >= '{day.strftime('%Y-%m-%d')}' "
        f"AND `{self.hourly_measurements_table}`.pm2_5_raw_value IS NOT NULL "
    )

WHY IS THIS NEEDED?

Without the backticks, the SQL query fails due to syntax errors. Adding backticks ensures that the SQL parser interprets the identifiers correctly, preventing errors and ensuring the query runs successfully.

ERROR MESSAGE Error: BadRequest: 400 Syntax error: Expected end of input but got "." at [2:40]; reason: invalidQuery, location: query, message: Syntax error: Expected end of input but got "." at [2:40]

HOW DO I TEST OUT THIS PR?

from airqo_etl_utils.bigquery_api import BigQueryApi
from datetime import datetime, timezone, timedelta

# Initialize the BigQuery API client
big_query_api = BigQueryApi()

# Define the day for the query
day = datetime.now(timezone.utc) - timedelta(days=15)

# Call the function and print the result
try:
    result = big_query_api.get_devices_hourly_data(day=day)
    print(result)
except Exception as e:
    print(f"An error occurred: {e}")

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago
Walkthrough ## Walkthrough The changes primarily focus on syntax corrections, improved formatting, and minor updates in SQL queries across multiple files. Notable updates include using backticks for table references in SQL, adding blank lines for readability in functions, and adjusting parameter formatting in DAG definitions. These improvements enhance code readability and ensure proper SQL syntax compliance. ## Changes | File Path | Change Summary | |----------------------------|------------------------------------------------------------------------------------------------------------| | `src/.../bigquery_api.py` | Updated SQL query string to use backticks for table references and correct `IS NOT NULL` syntax. | | `src/.../airnow.py` | Added blank lines before and after function definitions for `send_to_api`, `airnow_bam_realtime_data`, and `airnow_bam_historical_data`. | | `src/.../airqo_bam_measurements.py` | Adjusted `start_date` parameter formatting and made whitespace changes in the DAG definition for historical BAM measurements. | ## Poem > In code, we weave our smart design, > With backticks and syntax so divine. > Queries neat and functions clear, > Our ETL flows without a fear. > Through whitespace and reformats new, > Our data paths are smooth and true. > > 📊✨ Coders' craft, a well-read rhyme, > Enhancing flow, one line at a time.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 30.30%. Comparing base (214d559) to head (72ce7db).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3230/graphs/tree.svg?width=650&height=150&src=pr&token=HHq3qS3cL6&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform)](https://app.codecov.io/gh/airqo-platform/AirQo-api/pull/3230?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=airqo-platform) ```diff @@ Coverage Diff @@ ## staging #3230 +/- ## ======================================== Coverage 30.30% 30.30% ======================================== Files 184 184 Lines 24487 24487 Branches 3205 3205 ======================================== Hits 7421 7421 Misses 16952 16952 Partials 114 114 ```