Доступ к данным с помощью курсоров

Курсор – это объект доступа к данным, который может использоваться как для итерации набора строк в таблице, так и для вставки новых строк в таблицу. Курсоры могут быть трех форм: поиска, вставки и обновления. Как правило, курсоры используются для считывания существующей геометрии и записи новых геометрий.

Любой тип курсора создается соответствующей функцией ArcPy (SearchCursor, InsertCursor или UpdateCursor) в таблице, представлении таблицы, классе объектов или векторном слое. Курсор поиска может использоваться для быстрой выборки строк. Курсор обновления может использоваться для обновления и удаления строк, тогда как курсор вставки – для вставки строк в таблицу или в класс объектов.

Функции курсора доступа к данным (arcpy.da)

Курсор	Объяснение
arcpy.da.InsertCursor(in_table, field_names)	Вставляет строки
arcpy.da.SearchCursor(in_table, field_names, {where_clause}, {spatial_reference}, {explode_to_points}, {sql_clause})	Доступ только для чтения
arcpy.da.UpdateCursor(in_table, field_names, {where_clause}, {spatial_reference}, {explode_to_points}, {sql_clause})	Обновляет или удаляет строки

Прежние версии:

В ArcGIS 10.1 добавлен модуль доступа к данным (arcpy.da). Оригинальные курсоры по-прежнему поддерживаются, однако новые курсоры arcpy.da обеспечивают значительно более высокую производительность. В большинстве случаев использование курсоров arcpy.da описывается в справочной документации. Более подробную информацию о классической модели курсоров см. в InsertCursor, SearchCursor и в разделах UpdateCursor.

Примечание:

Курсоры учитывают определяющие запросы к представлениям слоев и таблиц и выборки. Объект курсора содержит в этом случае только те строки, которые бы использовались любыми инструментами геообработки в это время.

Курсоры можно перемещать только в направлении вперед. Их нельзя передвинуть назад и выбрать строки, которые уже были выбраны. Если скрипту надо несколько раз пройти по данным, можно выбрать метод курсора reset.

Курсоры поиска и обновления можно повторять с помощью цикла for. К следующей строке можно перейти методом next для возврата следующей строки. При использовании на курсоре метода next, чтобы найти все строки в таблице, содержащей n строк, скрипт должен вызвать next N-ное количество раз. Вызов next после получения последней выбранной строки в наборе результатов возвращает исключение StopIteration.

import arcpy

cursor = arcpy.da.SearchCursor(fc, ['fieldA', 'fieldB'])
for row in cursor:
    print(row)

Курсоры поиска и обновления также поддерживают выражения with.

import arcpy

with arcpy.da.SearchCursor(fc, ['fieldA', 'fieldB']) as cursor:
    for row in cursor:
        print(row)

Все строки, извлеченные из таблицы, выдаются в виде списка значений поля. Эти значения будут выводиться в том же порядке, как они задавались для аргумента курсора field_names. Для подтверждения порядка значений полей может также использоваться свойство курсора fields.

Объект курсора

SearchCursor, UpdateCursor и InsertCursor создают объект курсора, который может использоваться для итерации по записям. Методы объекта курсора, созданного различными функциями курсора, различаются в зависимости от типа созданного курсора.

В таблице ниже представлены методы, поддерживаемые каждым типом курсора:

Тип курсора	Метод
arcpy.da.SearchCursor	reset - Сбрасывает курсор в начальное положение.
arcpy.da.InsertCursor	insertRow - Вставляет строку в таблицу.
arcpy.da.UpdateCursor	updateRow - Обновляет текущую строку.
	deleteRow - Удаляет строку из таблицы
	reset - Сбрасывает курсор в начальное положение.

insertRow

Курсор вставки используется для создания и вставки строк. После создания курсора для вставки списка (или набора) значений, образующих новую строку, используется метод insertRow. Любому полю в таблице, не включенному в курсор, назначается значение поля по умолчанию.

import arcpy

# Create insert cursor for table
cursor = arcpy.da.InsertCursor("c:/base/data.gdb/roads_lut", 
                               ["roadID", "distance"])

# Create 25 new rows. Set the initial row ID and distance values
for i in range(0,25):
    cursor.insertRow([i, 100])

updateRow

Метод updateRow используется для обновления строки в текущем положении курсора обновления. После возврата строки из объекта курсора можно при необходимости изменить строку и вызвать updateRow, передав измененную строку.

import arcpy

# Create update cursor for feature class
with arcpy.da.UpdateCursor("c:/base/data.gdb/roads",
                           ["roadtype", "distance"]) as cursor:
    for row in cursor:
        # Update the values in the distance field by multiplying 
        #   the roadtype by 100. Road type is either 1, 2, 3 or 4.
        row[1] = row[0] * 100
        cursor.updateRow(row)

deleteRow

Метод deleteRow используется для удаления строки в текущем положении курсора обновления. После выбора строки вызовите deleteRow в курсоре для удаления строки.

import arcpy

# Create update cursor for feature class
with arcpy.da.UpdateCursor("c:/base/data.gdb/roads", 
                          ["roadtype"]) as cursor:
    # Delete all rows that have a roads type of 4
    for row in cursor:
        if row[0] == 4:
            cursor.deleteRow()

Доступ к значениям поля и их установка

Для каждого курсора используемые поля предоставляются списком или кортежем имен полей. При возврате строки из курсора, строка возвращается как список значений полей, соответствующих положению указателя.

В примере ниже доступ к названию штата и количеству населения осуществляется по положению.

import arcpy

fc = "c:/base/data.gdb/USA/States"

# Use SearchCursor to access state name and the population count
with arcpy.da.SearchCursor(fc, ['STATE_NAME', 'POP2000']) as cursor:
    for row in cursor:
        # Access and print the row values by index position.
        #   state name: row[0]
        #   population: row[1]
        print('{} has a population of {}'.format(row[0], row[1]))

Подсказка:

Несмотря на то, что доступ ко всем полям можно получить с помощью звездочки (*), делать это не рекомендуется. Чем больше заданных полей, тем медленнее работает курсор. Включение в список только тех полей, которые будут использоваться, улучшает производительность курсора.

Можно также использовать токены в качестве сокращений вместо имен полей. Все таблицы включают поле ObjectID, которое может иметь множество различных имен в зависимости от типа данных. Простым классам объектов требуется поле геометрии, обычно (но не всегда) именуемое Shape. Для доступа к полю ObjectID может использоваться токен OID@, а токен SHAPE@ (возвращающий объект геометрии) – для доступа к полю геометрии класса объектов, когда имена этих полей заранее не известны.

SearchCursor на классе мультиточечных объектов

import arcpy

infc = arcpy.GetParameterAsText(0)

# Enter for loop for each feature
for row in arcpy.da.SearchCursor(infc, ["OID@", "SHAPE@"]):
    # Print the current multipoint's ID
    print("Feature {}:".format(row[0]))

    # For each point in the multipoint feature,
    #  print the x,y coordinates
    for pnt in row[1]:
        print("{}, {}".format(pnt.X, pnt.Y))

Дополнительные токены геометрии можно использовать для доступа к конкретным сведениям о геометрии. Доступ к полной геометрии требует больше времени. Если требуются только конкретные свойства геометрии, используйте токены, чтобы предоставить быстрый доступ к свойствам геометрии. Например, SHAPE@XY возвращает набор координат x и y, представляющий центроид объекта.

Ниже следует более подробная инфоромация о некоторых конкретных типах полей.

Поля глобальных идентификаторов

Типы полей Global ID и GUID содержат строки в стиле реестра, состоящие из 36 символов, заключенных в фигурные скобки. Эти строки уникально определяют объект или запись таблицы внутри и вне базы геоданных.

В курсоре поля GUID могут воспринимать строковые значения и значения универсального уникального идентификатора (UUID). Считывание полей Global ID и GUID возвращает строку.

Добавьте запись в поле GUID, используя значение UUID.

import arcpy
import uuid

ic = arcpy.da.InsertCursor('a', ['guid_field'])
id = uuid.uuid1()
ic.insertRow([id])

Добавьте запись в поле GUID, используя строку.

import arcpy

ic = arcpy.da.InsertCursor('a', ['date_field'])
id = '0345e170-2614-11eb-812d-f8b156b0d357'
ic.insertRow([id])

Поля дат

Поля дат могут сохранять даты и значения времени.

В курсоре поле даты может работать с объектом datetime или со строковым значением. Считывание полей дат возвращает объект datetime.

Добавьте запись в поле дат, используя объект datetime.

import arcpy
from datetime import datetime

ic = arcpy.da.InsertCursor('a', ['date_field'])
date_value = datetime(2020, 7, 1, 12, 30)
ic.insertRow([date_value])

Добавьте запись в поле дат, используя строковое значение.

import arcpy

ic = arcpy.da.InsertCursor('a', ['date_field'])
date_value = "July 1 2020 12:30)
ic.insertRow([date_value])

Поля BLOB

Большой двоичный объект - это данные, хранящиеся в виде длинной последовательности двоичных чисел. ArcGIS хранит в виде больших двоичных объектов (BLOB) аннотации и объекты-размеры (dimension), а также такие элементы, как изображения, мультимедиа или фрагменты кода. Курсор можно использовать для загрузки или просмотра содержимого поля BLOB.

В курсоре поля BLOB воспринимают строки, объекты bytes и объекты memoryview. Считывание полей BLOB возвращает объект memoryview.

Добавьте запись в поле BLOB, используя файл .png.

import arcpy

data = open("c:/images/image1.png", "rb").read()
ic = arcpy.da.InsertCursor("c:/data/fgdb.gdb/fc", ['imageblob'])
ic.insertRow([data])

Прочитайте поле BLOB как объекта memoryview и запишите в файл .png.

import arcpy

sc = arcpy.da.SearchCursor("c:/data/fgdb.gdb/fc", ["imageblob"])
memview = sc.next()[0]
open("c:/images/image1_copy.png", "wb").write(memview.tobytes())

Курсоры и блокировка

Курсоры вставки и обновления соблюдают блокировки таблицы, установленные приложениями ArcGIS. Блокировки предохраняют сложные процессы от изменения одной и той же таблицы одновременно. Существует два типа блокировок, общие и эксклюзивные:

• Общая блокировка применяется в любое время к таблице или набору данных, к которым производится доступ. Несколько общих блокировок может быть создано для таблицы, но если имеется общая блокировка, то создание эксклюзивной блокировки запрещается. Отображение класса объектов и предварительный просмотр таблицы являются примерами общей блокировки.
• Эксклюзивные блокировки применяются при внесении изменений в таблицу или класс объекта. Эксклюзивная блокировка применяется ArcGIS, например, при редактировании и сохранении класса пространственных объектов в карте, изменении схемы таблицы или при использовании курсора вставки для класса объектов в Python IDE.

Курсоры обновления и вставки не могут быть созданы для таблицы или класса объектов при наличии эксклюзивной блокировки для набора данных. Из-за эксклюзивной блокировки набора данных функции UpdateCursor или InsertCursor работать не будут. Если эти функции успешно создают курсор, то они используют эксклюзивную блокировку для набора данных так, чтобы два скрипта не могли создать курсор обновления или вставки для того же набора данных.

Курсоры поддерживают выражения with для сброса итераций и помогают снимать блокировки. Однако использование выражения del удаляет объект или заводит курсор в функцию для того, чтобы объект-курсор вышел из области применения, нужно принять во внимание настройки безопасности в случае блокировок.

В сеансе редактирования создается общая блокировка данных на время сеанса. Эксклюзивная блокировка применяется при сохранении изменений. Если уже существует эксклюзивная блокировка, то набор данных нельзя редактировать.