SQLSpecialColumns, функция

Соответствия
Представлена версия: соответствие стандартам ODBC 1.0: open Group

Сводка
SQLSpecialColumns получает следующие сведения о столбцах в указанной таблице:

• Оптимальный набор столбцов, однозначно определяющих строку в таблице.

• Столбцы, которые автоматически обновляются при обновлении любого значения в строке транзакцией.

Синтаксис

  
SQLRETURN SQLSpecialColumns(  
     SQLHSTMT      StatementHandle,  
     SQLSMALLINT   IdentifierType,  
     SQLCHAR *     CatalogName,  
     SQLSMALLINT   NameLength1,  
     SQLCHAR *     SchemaName,  
     SQLSMALLINT   NameLength2,  
     SQLCHAR *     TableName,  
     SQLSMALLINT   NameLength3,  
     SQLSMALLINT   Scope,  
     SQLSMALLINT   Nullable);  

Аргументы

ОператорHandle
[Входные данные] Дескриптор инструкции.

ИдентификаторТип
[Входные данные] Тип возвращаемого столбца. Необходимо установить одно из следующих значений.

SQL_BEST_ROWID. Возвращает оптимальный столбец или набор столбцов, которые, извлекая значения из столбца или столбцов, позволяют однозначно определить любую строку в указанной таблице. Столбец может быть либо псевдоколонтитулов, специально разработанный для этой цели (как в Oracle ROWID или Ingres TID), либо столбец или столбцы любого уникального индекса для таблицы.

SQL_ROWVER. Возвращает столбец или столбцы в указанной таблице, которые автоматически обновляются источником данных, когда любое значение в строке обновляется любой транзакцией (как в SQLBase ROWID или Sybase TIMESTAMP).

Имя каталога
[Входные данные] Имя каталога для таблицы. Если драйвер поддерживает каталоги для некоторых таблиц, но не для других, например, когда драйвер получает данные из разных СУБД, пустая строка ("") обозначает те таблицы, которые не имеют каталогов. CatalogName не может содержать шаблон поиска строк.

Если для атрибута инструкции SQL_ATTR_METADATA_ID задано значение SQL_TRUE, Имя каталога рассматривается как идентификатор, и его регистр не имеет значения. Если это SQL_FALSE, CatalogName является обычным аргументом; он обрабатывается буквально, и его дело является значительным. Дополнительные сведения см. в разделе "Аргументы" в функциях каталога.

NameLength1
[Входные данные] Длина символов *CatalogName.

Schemaname
[Входные данные] Имя схемы для таблицы. Если драйвер поддерживает схемы для некоторых таблиц, но не для других, например, когда драйвер извлекает данные из разных СУБД, пустая строка ("") обозначает те таблицы, которые не имеют схем. SchemaName не может содержать шаблон поиска строк.

Если для атрибута инструкции SQL_ATTR_METADATA_ID задано значение SQL_TRUE, schemaName обрабатывается как идентификатор, и его регистр не имеет значения. Если это SQL_FALSE, SchemaName является обычным аргументом; он обрабатывается буквально, и его дело является значительным.

NameLength2
[Входные данные] Длина символов *SchemaName.

TableName
[Входные данные] Имя таблицы. Этот аргумент не может быть пустым указателем. TableName не может содержать шаблон поиска строк.

Если для атрибута инструкции SQL_ATTR_METADATA_ID задано значение SQL_TRUE, TableName обрабатывается как идентификатор, и его регистр не имеет значения. Если это SQL_FALSE, TableName является обычным аргументом; он обрабатывается буквально, и его дело является значительным.

NameLength3
[Входные данные] Длина символов *TableName.

Область применения
[Входные данные] Минимальный обязательный область строкового идентификатора. Возвращаемый строковой идентификатор может быть больше область. Должна быть одной из следующих:

SQL_SCOPE_CURROW: идентификатор rowid гарантированно является допустимым только при расположении в этой строке. Более поздняя повторная выборка с помощью rowid может не возвращать строку, если строка была обновлена или удалена другой транзакцией.

SQL_SCOPE_TRANSACTION. Идентификатор строки гарантированно действителен в течение текущей транзакции.

SQL_SCOPE_SESSION. Идентификатор строки гарантированно действителен в течение сеанса (через границы транзакций).

Допускает значения NULL
[Входные данные] Определяет, следует ли возвращать специальные столбцы, которые могут иметь значение NULL. Должна быть одной из следующих:

SQL_NO_NULLS. Исключите специальные столбцы, которые могут иметь значения NULL. Некоторые драйверы не могут поддерживать SQL_NO_NULLS, и эти драйверы возвращают пустой результирующий набор, если SQL_NO_NULLS был указан. Приложения должны быть подготовлены к этому делу и запрашивать SQL_NO_NULLS только в том случае, если это абсолютно необходимо.

SQL_NULLABLE. Возвращает специальные столбцы, даже если они могут иметь значения NULL.

Возвраты

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR или SQL_INVALID_HANDLE.

Диагностика

Когда SQLSpecialColumns возвращает SQL_ERROR или SQL_SUCCESS_WITH_INFO, связанное значение SQLSTATE может быть получено путем вызова SQLGetDiagRec с handleType SQL_HANDLE_STMT и дескриптором statementHandle. В следующей таблице перечислены значения SQLSTATE, которые обычно возвращаются SQLSpecialColumns и объясняются каждый из них в контексте этой функции. Нотация "(DM)" предшествует описаниям SQLSTATEs, возвращаемым диспетчером драйверов. Возвращаемый код, связанный с каждым значением SQLSTATE, SQL_ERROR, если не указано иное.

Комментарии

Если аргумент IdentifierType SQL_BEST_ROWID, SQLSpecialColumns возвращает столбец или столбцы, однозначно определяющие каждую строку в таблице. Эти столбцы всегда можно использовать в предложении select-list или WHERE . SQLColumns, который используется для возврата различных сведений о столбцах таблицы, не обязательно возвращает столбцы, которые однозначно определяют каждую строку или столбцы, которые автоматически обновляются при обновлении любого значения в строке транзакцией. Например, SQLColumns может не возвращать псевдоколонок Oracle ROWID. Именно поэтому SQLSpecialColumns используется для возврата этих столбцов. Дополнительные сведения см. в разделе "Использование данных каталога".

Если в таблице нет уникальных столбцов, то SQLSpecialColumns возвращает набор строк без строк; последующий вызов SQLFetch или SQLFetchScroll в инструкции возвращает SQL_NO_DATA.

Если аргументы IdentifierType, Scope или NULL указывают характеристики, которые не поддерживаются источником данных, SQLSpecialColumns возвращает пустой результирующий набор.

Если для атрибута инструкции SQL_ATTR_METADATA_ID задано значение SQL_TRUE, аргументы CatalogName, SchemaName и TableName обрабатываются как идентификаторы, поэтому они не могут быть заданы в значении NULL указателя в определенных ситуациях. (Дополнительные сведения см. в разделе Аргументы в функциях каталога.)

SQLSpecialColumns возвращает результаты в виде стандартного результирующий набор, упорядоченный по области.

Следующие столбцы были переименованы для ODBC 3.x. Изменения имени столбца не влияют на обратную совместимость, так как приложения привязываются по номеру столбца.

Чтобы определить фактическую длину столбца COLUMN_NAME, приложение может вызвать SQLGetInfo с параметром SQL_MAX_COLUMN_NAME_LEN.

В следующей таблице перечислены столбцы в результирующем наборе. Дополнительные столбцы за пределами столбца 8 (PSEUDO_COLUMN) можно определить драйвером. Приложение должно получить доступ к столбцам для конкретного драйвера, отсчитывая от конца результирующего набора, а не указывая явное порядковое положение. Дополнительные сведения см. в разделе "Данные, возвращаемые функциями каталога".

После получения значений для SQL_BEST_ROWID приложение может использовать эти значения для повторного выбора строки в определенной область. Инструкция SELECT гарантированно возвращает ни строки, ни одну строку.

Если приложение повторно выбирает строку на основе столбца или столбца rowid, а строка не найдена, приложение может предположить, что строка была удалена или были изменены столбцы rowid. Противоположность неправда: даже если идентификатор строки не изменился, другие столбцы в строке могут измениться.

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

Столбец или столбцы строкового идентификатора могут оставаться допустимыми, даже если курсор не расположен в строке; Приложение может определить это, проверка столбца SCOPE в результирующем наборе.

Столбцы, возвращаемые для типа столбцов, SQL_ROWVER полезны для приложений, которым требуется возможность проверка, были ли обновлены все столбцы в заданной строке, а строка была изменена с помощью строкового идентификатора. Например, после повторного выбора строки с помощью rowid приложение может сравнить предыдущие значения в столбцах SQL_ROWVER только что извлекаемых. Если значение в столбце SQL_ROWVER отличается от предыдущего значения, приложение может предупредить пользователя о том, что данные на дисплее изменились.

Пример кода

Пример кода аналогичной функции см . в разделе SQLColumns.

Связанные функции

См. также

Справочник по API ODBC
Файлы заголовков ODBC