RdsTabulateParameters

Hierarchy

RdsCommonQueryParameters
- RdsTabulateParameters

Indexable

[key: string]: RdsCommonQueryParameters[keyof RdsCommonQueryParameters]

Index

Properties

Optional count

count: undefined | false | true

Flag specifying whether the total row count should be returned along side the data.

Optional dims

dims: undefined | string

Columns to use as dimensions.

example: dims=V[0-9]+,V1a,$keyword

Optional format

format: RdsFormatParamter

RDS can return a variety of JSON objects to plug into various java script charting libraries. Defaults to mtna_simple.

Optional groupby

groupby: string[]

When computing a new variable using a function that depends onaggregation the group by parameter can specify which columns to group by.

example: groupby=V1,V2

Optional inject

inject: undefined | false | true

Flag specifying to inject codes into the returned records.

Optional limit

limit: undefined | number

The limit of records to return.

Optional measure

measure: undefined | string

Columns to use as measures. Count is used by default.

example: measure=avg:AVG(V1)

Optional metadata

metadata: undefined | false | true

Flag specifying if metadata should be returned along side the data.

Optional offset

offset: undefined | number

The record to start at.

Optional orderby

orderby: undefined | string

Allows the data to be reordered in ascending or descending order by column.

example: orderby=V1 DESC,V2 ASC

Optional totals

totals: undefined | false | true

Flag specifying whether subtotals should be returned along side the data.

Optional weights

weights: string[]

The IDs of variables to use as weights in the resulting data.

Optional where

where: undefined | string

The where parameter allows filters to be applied to the data that will be returned. This follows a syntax similar to a SQL where clause.

example: where=V1=1 AND V2=2

Generated using TypeDoc