Create a new RdsDataProduct which provides methods to interact with data product related endpoints on the RDS API.
the RDS Catalog on which this data product exists
the ID of this specific data product
whether to automatically start resolving all the data products's own properties, defaults to false
the RDS Catalog on which this data product exists
the ID of this specific data product
The url for data product related API endpoints.
The url for query related API endpoints for this specific data product.
Get record count. Runs a query to count the records of the specified data product.
the number of records within the data product.
whether this resource is resolved
whether this resource is resolving
Register a listener that will emit when this resource has been resolved sucessfully.
the listener for when this resource has been resolved
Get data product. This shows a single data product in a catalog, there is no additional information in this call, it simply limits the scope of what is returned.
a promise that completes once the data product is resolved
Run select query. Running a select query on the specified data product returns record level microdata. A variety of querying techniques can be used to subset, compute, order, filter and format the results.
Optional parameters for an RDS select query
Record level microdata, the shape will vary depending on the format query paramter.
Setter for resolved.
whether this resource is resolved
Setter for resolving.
whether the resource is resolving
Run tabulation query. Running tabulations on the specified data product returns aggregate level data about the dimensions and measures specified. A variety of querying techniques can be used to subset, compute, order, filter and format the results.
Optional parameters for an RDS tabulate query
Aggregate level data about the dimensions and measures specified.
The shape will vary depending on the format query paramter.
Generated using TypeDoc
An instance of a RDS Data Product. A basic building block to interact with a RDS API. Includes methods to query data product related information.
const covidServer = new RdsServer('https://covid19.richdataservices.com/rds'); const covidCatalog = new RdsCatalog(covidServer, 'int'); const dataProduct = new RdsDataProduct(covidCatalog, 'jhu_country'); dataProduct .select() .then( res => console.log('Data:', res.parsedBody), error => console.error('Oh no!', error) );