studio

Documentation

Overview

Package studio provides AQL (Aha Query Language) - a JQL-like query layer for Aha.io.

Studio supports querying Ideas, Features, Releases, and Initiatives using SQL-like syntax.

Example usage:

client, _ := aha.NewClient()
studio := studio.New(client)
result, _ := studio.Query(ctx, "FROM features WHERE status = 'In Progress' LIMIT 10")
for _, record := range result.Records {
    fmt.Println(record["name"])
}

Index

• Constants
• func Parse(aql string) (*ast.Query, error)
• func Plan(aql string) (*planner.Plan, error)
• func Validate(aql string) error
• type QueryOptions
• type Studio
  • func New(client *aha.Client) *Studio
  • func (s *Studio) Client() *aha.Client
  • func (s *Studio) Query(ctx context.Context, aql string) (*result.Result, error)
  • func (s *Studio) QueryWithOptions(ctx context.Context, aql string, opts QueryOptions) (*result.Result, error)

Constants

const Version = "0.1.0"

Version is the library version.

Functions

func Parse

func Parse(aql string) (*ast.Query, error)

Parse parses an AQL query and returns the AST. This is useful for query validation without execution.

func Plan

func Plan(aql string) (*planner.Plan, error)

Plan creates an execution plan for an AQL query. This is useful for inspecting how a query will be executed.

func Validate

func Validate(aql string) error

Validate validates an AQL query. Returns nil if the query is valid.

Types

type QueryOptions

type QueryOptions struct {
	// ProductID is required for releases queries.
	ProductID string

	// ReleaseID is required for release-scoped feature queries.
	ReleaseID string
}

QueryOptions configures query execution.

type Studio

type Studio struct {
	// contains filtered or unexported fields
}

Studio provides the main interface for AQL queries.

func New

func New(client *aha.Client) *Studio

New creates a new Studio instance with the given Aha client.

func (*Studio) Client

func (s *Studio) Client() *aha.Client

Client returns the underlying Aha client.

func (*Studio) Query

func (s *Studio) Query(ctx context.Context, aql string) (*result.Result, error)

Query executes an AQL query and returns the results.

func (*Studio) QueryWithOptions

func (s *Studio) QueryWithOptions(ctx context.Context, aql string, opts QueryOptions) (*result.Result, error)

QueryWithOptions executes an AQL query with the given options.