RecordSet

Summary

RecordSet objects are a lightweight representation of a table. They are a data element that contains not only schema, but also the data. The RecordSet object is also how tables are sent and received from the server.

Discussion

• Using the RecordSet as input to a tool or function that modifies the input, such as Calculate Field or UpdateCursor, will modify the original table.
• Loading a new table into a RecordSet will not overwrite the original table. The load method will only change the reference to the table, not the original table itself.

Syntax

 RecordSet ({table_path}, {where_clause})

Parameter	Explanation	Data Type
table_path	The table to load into the RecordSet object. The input can be a catalog path to a feature class, a URL to a hosted feature layer, a JSON with the syntax {"url":"<url>", "serviceToken":"<serviceToken>"} to load data from external sources that require an access token, or an Esri (featureSet) JSON string. An Esri JSON is a standard for encoding feature (geometry and attribute) data as a JSON (.json) file. For tables, the JSON does not include geometryType, spatialReference, or geometry keys.	String
where_clause	An SQL expression used to select a subset of records. For more information on SQL syntax, see SQL reference for query expressions used in ArcGIS. (The default value is None)	String

Properties

Property	Explanation	Data Type
JSON (Read Only)	Returns an Esri JSON representation of the geometry as a string. Tip: The returned string can be converted to a dictionary using the json module's loads function.	String
GeoJSON (Read Only)	Returns a GeoJSON representation of the geometry as a string. Tip: The returned string can be converted to a dictionary using the json module's loads function.	String

Method Overview

Method	Explanation
load ({table_path}, {where_clause})	Loads a table into the RecordSet object.
save (table_path)	Export to a table.

Methods

load ({table_path}, {where_clause})

Parameter	Explanation	Data Type
table_path	The table to load into the RecordSet object. The input can be a catalog path to a feature class, a URL to a hosted feature layer, a JSON with the syntax {"url":"<url>", "serviceToken":"<serviceToken>"} to load data from external sources that require an access token, or an Esri (featureSet) JSON string. An Esri JSON is a standard for encoding feature (geometry and attribute) data as a JSON (.json) file. For tables, the JSON does not include geometryType, spatialReference, or geometry keys.	String
where_clause	An SQL expression used to select a subset of records. For more information on SQL syntax, see SQL reference for query expressions used in ArcGIS. (The default value is None)	String

save (table_path)

Parameter	Explanation	Data Type
table_path	The output table to be created.	String

Code sample

RecordSet example 1

Import a server toolbox; get the RecordSet object from the server tool's specified parameter.

import arcpy

# Add a custom server toolbox
arcpy.ImportToolbox("http://myserver/arcgis/services;Geocode")

# Get recordset from server tool's first parameter to use as schema
in_recordset = arcpy.GetParameterValue("GeocodeAddress", 0)

RecordSet example 2

Create a RecordSet object and load a subset of a hosted table.

import arcpy

# Set data
in_dataset = "https://maps.my.org/arcgis/rest/services/Tables/MapServer/0"
query = "Country_Code: 'IT'"

# Create RecordSet with query
record_set = arcpy.RecordSet(in_dataset, query)

RecordSet example 3

Create a RecordSet object from an Esri JSON string.

import arcpy

# Set data
data_json = '''{
 "objectIdFieldName": "objectid",
 "globalIdFieldName": "globalid",
 "fields": [
  {
   "name": "objectid",
   "alias": "OBJECTID",
   "type": "esriFieldTypeOID"
  },
  {
   "name": "requestid",
   "alias": "Service Request ID",
   "type": "esriFieldTypeString",
   "length": 25
  },
  {
   "name": "requesttype",
   "alias": "Problem",
   "type": "esriFieldTypeString",
   "length": 100
  },
  {
   "name": "comments",
   "alias": "Comments",
   "type": "esriFieldTypeString",
   "length": 255
  }
 ],
 "features": [
  {
   "attributes": {
    "objectid": 246362,
    "requestid": "1",
    "requesttype": "Sidewalk Damage",
    "comments": "Pothole"
   }
  },
  {
   "attributes": {
    "objectid": 246382,
    "requestid": "2",
    "requesttype": "Pothole",
    "comments": "Jhh"
   }
  }
 ]
}'''

# Create FeatureSet from Esri JSON
feature_set = arcpy.RecordSet(data_json)