read.collection_data()

Load a Rasgo Collection into a pandas DataFrame

Parameters

id:int:ID of Rasgo Collection to return

filters:dict: (Optional)SQL filters to apply to model data

limit:int: (Optional)Number of records to return

Return Object

pandas DataFrame

Sample Usage

Return an entire collection without filters

rasgo = pyrasgo.connect(api_key)

df = pd.DataFrame
df = rasgo.read.collection_data(7)

Return a collection with filtered results

df = rasgo.read.collection_data(id=7, 
                                filters={"DATE":"2020-12-25"}
                                )

df = rasgo.read.collection_data(id=7, 
                                filters={"DATE":">='2020-12-25'"}
                                )

df = rasgo.read.collection_data(id=7, 
                                filters={"DATE":"2020-12-25",
                                         "FIPS":"BETWEEN '0000' AND '2000'"},
                                limit=100
                                )

Best Practices / Tips

NOTE: Filter syntax is a pyton dictionary: { k : v } Where: k= field to apply filter to v= valid ANSI sql logic

Supported SQL Filters are:

• ">" Greater than

• "<" Less than

• ">=" Greater than or eqaul to

• "<=" Less than or equal to

• "<>" or "!=" Does not equal

• "IN (x,y,z)" In (list)

• "BETWEEN x AND y" Between 2 values