Information Returned

• We will begin by looking at an example of the information returned by the simple select query, yours may look different but should contain the same general information. 

  Full Data Info

   {
  	records: [...],
  	info: {
  		colOffset: 0,
  		colCount: 67,
  		moreCols: false,
  		format: "MTNA",
  		includeMetadata: false,
  		limit: 20,
  		offset: 0,
  		moreRows: true
  	}
  }

  
  

Paginating Columns

• The view in this example has a total of 67 variables (columns) and has limited the records returned to 20 by default. To limit the columns use the colLimit parameter.

  Select Query Column Subset

  http://{host}/rds/api/catalog/{collection}/{view}/select?colLimit=10

  
  

  Info Expand source

  {
  	records: [...],
  	info: {
  		colLimit: 10,
  		colOffset: 0,
  		colCount: 67,
  		moreCols: true,
  		format: "MTNA",
  		includeMetadata: false,
  		limit: 20,
  		offset: 0,
  		moreRows: true
  	}
  }

  
  

• Paging forward and backwards through the columns can be achieved by adjusting the colOffset parameter.

  Columns 11-20

  http://{host}/rds/api/catalog/{collection}/{view}/select?colLimit=10&colOffset=10

  
  

  Columns 21-30

  http://{host}/rds/api/catalog/{collection}/{view}/select?colLimit=10&colOffset=20

  
  

• When the last group of 10 (columns 61-67) is retrieved the moreCols property will be false, a quick and easy indication for any UI that there are no more columns. 

  http://{host}/rds/api/catalog/{collection}/{view}/select?colLimit=10&colOffset=60

  
  

  No More Columns Expand source

  {
  	records: [...],
  	info: {
  		colLimit: 10,
  		colOffset: 60,
  		colCount: 67,
  		moreCols: false, //This field is false because there are no more columns to return
  		format: "MTNA",
  		includeMetadata: false,
  		limit: 20,
  		offset: 0,
  		moreRows: true
  	}
  }

  
  

Paginating Records

• If developers want to see the count of total records for they view, the count parameter can be used. 

  Get Total Record Count

  http://{host}/rds/api/catalog/{collection}/{view}/select?count

  
  

  Total Record Count Expand source

  {
  	records: [...],
  	info: {
  		colOffset: 0,
  		colCount: 67,
  		moreCols: false,
  		format: "MTNA",
  		includeMetadata: false,
  		limit: 20,
  		offset: 0,
  		count: 662, // This field has been added to the info
  		moreRows: true
  	}
  }

  
  

• Record limits can be adjusted using the limit parameter. 

  Select 100 Records

  http://{host}/rds/api/catalog/{collection}/{view}/select?limit=100

  
  

• Records can be paginated using the offset parameter. 

  Records 101-200

  http://{host}/rds/api/catalog/{collection}/{view}/select?limit=100&offset=100

  
  

  Records 201-300

  http://{host}/rds/api/catalog/{collection}/{view}/select?limit=100&offset=200

  
  

• When the final records are reached the moreRows property will be returned as false. 

  No More Records Expand source

  {
  	records: [...],
  	info: {
  		colOffset: 0,
  		colCount: 67,
  		moreCols: false,
  		format: "MTNA",
  		includeMetadata: false,
  		limit: 100,
  		offset: 600,
  		moreRows: false // This field is now false
  	}
  }