Describe staged dataframes
fdic_dataframe_describeDescribe the df_ dataframes that fdic_query_financials and fdic_get_deposits staged when a result exceeded its inline preview, plus any that fdic_dataframe_query saved with register_as. Pass name (from a dataset field) for one dataframe in full: source tool, the parameters it was called with, row count, creation and expiry time, column schema, and the unit and basis of each amount, ratio, or count column (thousands of dollars, percent, or count). Read a table's columns this way before writing SQL for fdic_dataframe_query. Omit name to list the live dataframes, newest first, 50 per page, as name, source tool, row count, and expiry only. A deployment that serves HTTP without authentication, where every caller shares one canvas, does not list; there, pass the name a dataset field returned.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | A dataframe name (df_XXXXX_XXXXX, from a dataset field) for its provenance, columns, and units; omit to list the live dataframes where this deployment allows it. | |
| offset | No | Listed dataframes to skip; pass next_offset from the previous page. Ignored when name is set. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | Dataframes per page of the listing. | |
| error | No | Present when the call failed. Absent on success. | |
| shown | No | Dataframes listed on this page. | |
| total | No | Live dataframes across all pages of the listing; with name, 1 or 0. | |
| notice | No | Guidance when nothing matched, the page is past the end, the page starts past the first dataframe, or more pages remain. | |
| truncated | No | True when more dataframes remain beyond this page. | |
| dataframes | No | The named dataframe in full, or one page of the live dataframes as summary rows, newest first; empty when none matched. | |
| next_offset | No | Offset of the next page of the listing; present when more dataframes remain. |