Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Major refactor of Shillelagh adapter implementation #43

Merged
merged 22 commits into from
May 29, 2024
Merged

Commits on May 24, 2024

  1. fix: flags for textual

    devraj committed May 24, 2024
    Configuration menu
    Copy the full SHA
    0d2ad59 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    6dd5b6a View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    1db824c View commit details
    Browse the repository at this point in the history

Commits on May 25, 2024

  1. Configuration menu
    Copy the full SHA
    b814dd3 View commit details
    Browse the repository at this point in the history
  2. fix: inconsistent topic names

    devraj committed May 25, 2024
    Configuration menu
    Copy the full SHA
    449bd61 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    e8764d7 View commit details
    Browse the repository at this point in the history
  4. refactor: moves cardholder endpoints out of subpackage

    the cardholders endpoints were defined in cc.cardholders.cardholders, while i have
    been implementing the alarm endpoints i have kept them in the top level package
    and the others in subpackages, this structure is mostly to corelate to how the
    documentaiton is presented by gallagher
    devraj committed May 25, 2024
    Configuration menu
    Copy the full SHA
    2cc2f0a View commit details
    Browse the repository at this point in the history

Commits on May 27, 2024

  1. fix: slogan for sql interface

    devraj committed May 27, 2024
    Configuration menu
    Copy the full SHA
    84e516b View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    40bef4d View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    7e5f4da View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    29bc168 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    279f95b View commit details
    Browse the repository at this point in the history
  6. refactor: moves initialisation due to order of operation

    the helper needs to be initialised after the api key has been set
    hence moving this to the adapter class and not the cc helper, the
    logic is still maintained in the cc helper vtable package but
    executed in the adapter class
    
    at the moment various things are being initialised on the package level
    this should be reviwed before we merge things into master
    devraj committed May 27, 2024
    Configuration menu
    Copy the full SHA
    5032d29 View commit details
    Browse the repository at this point in the history
  7. refactor!: initial column discovery implementation

    an extremely rough implementation of auto discovering column names from
    the matching DTO class, this introduces a sql_model attribute to the
    DTO configuration for getting things going.
    
    TODO: this has to be cleaned up and should not ship this way
    
    things to check:
    - read the DTO form the summary results
    - cache properties where possible for performance
    - revise how field type are instantiated when mapping occurs
    devraj committed May 27, 2024
    Configuration menu
    Copy the full SHA
    1de5049 View commit details
    Browse the repository at this point in the history
  8. docs: update missing types of DTO

    since the original incarnation i have introduced responses and payloads
    this is due to the project evolving and these should be documented
    in design.md
    devraj committed May 27, 2024
    Configuration menu
    Copy the full SHA
    2441e57 View commit details
    Browse the repository at this point in the history

Commits on May 28, 2024

  1. docs: adds NOTE links

    devraj committed May 28, 2024
    Configuration menu
    Copy the full SHA
    4137c12 View commit details
    Browse the repository at this point in the history
  2. docs: updates markdown with highlights

    while browsing some docs i found the use of highlights
    https://github.com/orgs/community/discussions/16925
    
    which i've migrated to using
    devraj committed May 28, 2024
    Configuration menu
    Copy the full SHA
    a983b4c View commit details
    Browse the repository at this point in the history
  3. refactor: drops the idea of vtables package

    the vtables package contains code that would sit directly in the
    adapter, so i am moving things directly into the adapter, moreover
    i thik that the core package sould be free of anything to do with
    shillelagh and hence moving as much shillelagh related things out
    of there as possible
    devraj committed May 28, 2024
    Configuration menu
    Copy the full SHA
    d96f9c8 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    0dcc5e7 View commit details
    Browse the repository at this point in the history

Commits on May 29, 2024

  1. refactor: clean up shillelagh implementation

    initially i was implementing a sql interface within the dto objects, as
    the solution grew it made more sense to be able to consolidate this into
    the shillelagh extension, ensuring that if the sql interface isn't in use
    the normal dto isn't burdened by imports
    
    i've kept some helper methods to concat dictionaries of annotations, this
    should not affect the workings of the solution
    
    refs #31
    devraj committed May 29, 2024
    Configuration menu
    Copy the full SHA
    2f45db0 View commit details
    Browse the repository at this point in the history
  2. refactor: adds property to return result_set

    result_set wraps the property from the class that should be returned
    this is because each summary or response has a different collection
    variable e.g cardholder has results where as alarms has alarms
    
    the wrapper is called result_set to signify how a sql orm or wrapper
    would refer to the results
    devraj committed May 29, 2024
    Configuration menu
    Copy the full SHA
    0bcd691 View commit details
    Browse the repository at this point in the history
  3. refactor: moves to using dto_retrieve to get sql

    using the detail dto_retrieve model to parse the sql responses returned
    to the shillelagh, things to check post this commit
    
    - can we get the detail fields when the user requests a model via where clause
    - is this the right thing to do (moving away from using the sql_model configuration)
    
    removes various TODO markers as appropriate where the issues have been resolved
    
    refs #31
    devraj committed May 29, 2024
    Configuration menu
    Copy the full SHA
    cc1b767 View commit details
    Browse the repository at this point in the history