apirtdatabaseq

Documentation

Overview

Package apirtdatabaseq contains the underlying implementation for the RTDatabaseq function and its types.

Package apirtdatabaseq contains internal implemetation for RTDatabase

Index

• type DatabaseqParams
• type DatabaseqResponse
  • func RTDatabaseq(runtime *apirtinit.MobrouteRuntime, params *DatabaseqParams) (*DatabaseqResponse, error)
• type FeedStatusInfo
• type FeedsearchFilter

Types

type DatabaseqParams

type DatabaseqParams struct {
	FeedIDs          []int             `json:"feed_ids"`
	FeedSearchFilter *FeedsearchFilter `json:"feed_searchfilter"`
}

DatabaseqParams holds parameters for the given RTDatabaseq request. There are two fields (FeedIDs and FeedSearchFilter) which may be specified which are used in an either/xor-fashion to determine the feeds to query the database state of.

• FeedIDs: Allows you to specify particular feed IDs to query the database status of.
• FeedSearchFilter: Allows you to specify a 'search filter' to determine feeds to query the database state of. Using the feed search filter allows you to build out 'search' interfaces to match the loaded Mobility Database for feed ID matches (e.g. see underlying struct Glob field and similar).

type DatabaseqResponse

type DatabaseqResponse = []FeedStatusInfo

DatabaseqResponse holds the response for the given RTDatabaseq function. Contains information about each feed queried.

This is an alias of the underlying FeedStatusInfo. Please see underlying type for further details.

func RTDatabaseq

func RTDatabaseq(runtime *apirtinit.MobrouteRuntime, params *DatabaseqParams) (*DatabaseqResponse, error)

RTDatabaseq queries database RO to determine GTFS feed loaded status (resulting from [RTDatabase]) & shows metadata for unloaded and loaded feeds. Takes the query params in DatabaseqParams and returns resulting set of feed data in DatabaseqResponse. This is an RO operation as opposed to [RTDatabase] which may manipulate the database as RW. This function is helpful for querying whether a load operation, or compute operation was successful and also determining the current database state and the state of GTFS feeds. Under-the-hood, this is a thin passthrough to the major RO functionality in Mobsql, allowing the user to query the underlying database. See DatabaseqParams for details on params.

Note, the related [RTDatabase] allows for manipulation (RW) functionality on the underlying database.

type FeedStatusInfo

type FeedStatusInfo = mobsql.FeedStatusInfo

FeedStatusInfo contains underlying info about a feed returned from RTDatabaseq

This is an alias of the underlying git.sr.ht/~mil/mobsql.FeedStatusInfo. Please see underlying type for further details.

type FeedsearchFilter

type FeedsearchFilter = mobsql.FeedsearchFilter

FeedsearchFilter contains a filter specification that can specify a search on metadatafields from the Mobility Database.

This is an alias of the underlying git.sr.ht/~mil/mobsql.FeedsearchFilter Please see underlying type for further details.