PostgreSQL Source Code  git master
Data Structures | Macros | Typedefs | Functions
skey.h File Reference
#include "access/attnum.h"
#include "access/stratnum.h"
#include "fmgr.h"
Include dependency graph for skey.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ScanKeyData
 

Macros

#define SK_ISNULL   0x0001 /* sk_argument is NULL */
 
#define SK_UNARY   0x0002 /* unary operator (not supported!) */
 
#define SK_ROW_HEADER   0x0004 /* row comparison header (see above) */
 
#define SK_ROW_MEMBER   0x0008 /* row comparison member (see above) */
 
#define SK_ROW_END   0x0010 /* last row comparison member */
 
#define SK_SEARCHARRAY   0x0020 /* scankey represents ScalarArrayOp */
 
#define SK_SEARCHNULL   0x0040 /* scankey represents "col IS NULL" */
 
#define SK_SEARCHNOTNULL   0x0080 /* scankey represents "col IS NOT NULL" */
 
#define SK_ORDER_BY   0x0100 /* scankey is for ORDER BY op */
 

Typedefs

typedef struct ScanKeyData ScanKeyData
 
typedef ScanKeyData * ScanKey
 

Functions

void ScanKeyInit (ScanKey entry, AttrNumber attributeNumber, StrategyNumber strategy, RegProcedure procedure, Datum argument)
 
void ScanKeyEntryInitialize (ScanKey entry, int flags, AttrNumber attributeNumber, StrategyNumber strategy, Oid subtype, Oid collation, RegProcedure procedure, Datum argument)
 
void ScanKeyEntryInitializeWithInfo (ScanKey entry, int flags, AttrNumber attributeNumber, StrategyNumber strategy, Oid subtype, Oid collation, FmgrInfo *finfo, Datum argument)
 

Macro Definition Documentation

◆ SK_ISNULL

#define SK_ISNULL   0x0001 /* sk_argument is NULL */

Definition at line 115 of file skey.h.

Referenced by _bt_check_rowcompare(), _bt_checkkeys(), _bt_compare(), _bt_compare_scankey_args(), _bt_first(), _bt_fix_scankey_strategy(), _bt_isequal(), _bt_mkscankey(), _bt_mkscankey_nodata(), _bt_preprocess_array_keys(), _hash_checkqual(), _hash_first(), blgetbitmap(), brin_inclusion_consistent(), brin_minmax_consistent(), bringetbitmap(), build_replindex_scan_key(), ExecIndexAdvanceArrayKeys(), ExecIndexBuildScanKeys(), ExecIndexEvalArrayKeys(), ExecIndexEvalRuntimeKeys(), get_actual_variable_range(), ginNewScanKey(), gistindex_keytest(), gistrescan(), and spgPrepareScanKeys().

◆ SK_ORDER_BY

#define SK_ORDER_BY   0x0100 /* scankey is for ORDER BY op */

Definition at line 123 of file skey.h.

Referenced by ExecIndexBuildScanKeys().

◆ SK_ROW_END

#define SK_ROW_END   0x0010 /* last row comparison member */

Definition at line 119 of file skey.h.

Referenced by _bt_check_rowcompare(), _bt_first(), _bt_fix_scankey_strategy(), and ExecIndexBuildScanKeys().

◆ SK_ROW_HEADER

#define SK_ROW_HEADER   0x0004 /* row comparison header (see above) */

Definition at line 117 of file skey.h.

Referenced by _bt_checkkeys(), _bt_first(), _bt_fix_scankey_strategy(), _bt_mark_scankey_required(), _bt_preprocess_array_keys(), _bt_preprocess_keys(), and ExecIndexBuildScanKeys().

◆ SK_ROW_MEMBER

#define SK_ROW_MEMBER   0x0008 /* row comparison member (see above) */

Definition at line 118 of file skey.h.

Referenced by _bt_check_rowcompare(), _bt_first(), _bt_fix_scankey_strategy(), _bt_mark_scankey_required(), and ExecIndexBuildScanKeys().

◆ SK_SEARCHARRAY

#define SK_SEARCHARRAY   0x0020 /* scankey represents ScalarArrayOp */

Definition at line 120 of file skey.h.

Referenced by _bt_preprocess_array_keys(), and ExecIndexBuildScanKeys().

◆ SK_SEARCHNOTNULL

#define SK_SEARCHNOTNULL   0x0080 /* scankey represents "col IS NOT NULL" */

Definition at line 122 of file skey.h.

Referenced by _bt_checkkeys(), _bt_compare_scankey_args(), _bt_first(), _bt_fix_scankey_strategy(), _bt_preprocess_array_keys(), brin_inclusion_consistent(), brin_minmax_consistent(), ExecIndexBuildScanKeys(), get_actual_variable_range(), gistindex_keytest(), gistrescan(), ScanKeyEntryInitialize(), and spgPrepareScanKeys().

◆ SK_SEARCHNULL

#define SK_SEARCHNULL   0x0040 /* scankey represents "col IS NULL" */

Definition at line 121 of file skey.h.

Referenced by _bt_checkkeys(), _bt_compare_scankey_args(), _bt_fix_scankey_strategy(), _bt_preprocess_array_keys(), _bt_preprocess_keys(), brin_inclusion_consistent(), brin_minmax_consistent(), ExecIndexBuildScanKeys(), gistindex_keytest(), gistrescan(), ScanKeyEntryInitialize(), and spgPrepareScanKeys().

◆ SK_UNARY

#define SK_UNARY   0x0002 /* unary operator (not supported!) */

Definition at line 116 of file skey.h.

Typedef Documentation

◆ ScanKey

typedef ScanKeyData* ScanKey

Definition at line 75 of file skey.h.

◆ ScanKeyData

typedef struct ScanKeyData ScanKeyData

Function Documentation

◆ ScanKeyEntryInitialize()

void ScanKeyEntryInitialize ( ScanKey  entry,
int  flags,
AttrNumber  attributeNumber,
StrategyNumber  strategy,
Oid  subtype,
Oid  collation,
RegProcedure  procedure,
Datum  argument 
)

Definition at line 32 of file scankey.c.

References Assert, fmgr_info(), MemSet, RegProcedureIsValid, ScanKeyData::sk_argument, ScanKeyData::sk_attno, ScanKeyData::sk_collation, ScanKeyData::sk_flags, ScanKeyData::sk_func, SK_SEARCHNOTNULL, SK_SEARCHNULL, ScanKeyData::sk_strategy, and ScanKeyData::sk_subtype.

Referenced by _bt_first(), check_exclusion_or_unique_constraint(), ExecIndexBuildScanKeys(), and get_actual_variable_range().

40 {
41  entry->sk_flags = flags;
42  entry->sk_attno = attributeNumber;
43  entry->sk_strategy = strategy;
44  entry->sk_subtype = subtype;
45  entry->sk_collation = collation;
46  entry->sk_argument = argument;
47  if (RegProcedureIsValid(procedure))
48  {
49  fmgr_info(procedure, &entry->sk_func);
50  }
51  else
52  {
53  Assert(flags & (SK_SEARCHNULL | SK_SEARCHNOTNULL));
54  MemSet(&entry->sk_func, 0, sizeof(entry->sk_func));
55  }
56 }
ScanKeyData::sk_subtype
Oid sk_subtype
Definition: skey.h:69
MemSet
#define MemSet(start, val, len)
Definition: c.h:908
fmgr_info
void fmgr_info(Oid functionId, FmgrInfo *finfo)
Definition: fmgr.c:123
ScanKeyData::sk_strategy
StrategyNumber sk_strategy
Definition: skey.h:68
RegProcedureIsValid
#define RegProcedureIsValid(p)
Definition: c.h:607
ScanKeyData::sk_func
FmgrInfo sk_func
Definition: skey.h:71
SK_SEARCHNOTNULL
#define SK_SEARCHNOTNULL
Definition: skey.h:122
ScanKeyData::sk_flags
int sk_flags
Definition: skey.h:66
Assert
#define Assert(condition)
Definition: c.h:699
ScanKeyData::sk_collation
Oid sk_collation
Definition: skey.h:70
ScanKeyData::sk_argument
Datum sk_argument
Definition: skey.h:72
SK_SEARCHNULL
#define SK_SEARCHNULL
Definition: skey.h:121
ScanKeyData::sk_attno
AttrNumber sk_attno
Definition: skey.h:67

◆ ScanKeyEntryInitializeWithInfo()

void ScanKeyEntryInitializeWithInfo ( ScanKey  entry,
int  flags,
AttrNumber  attributeNumber,
StrategyNumber  strategy,
Oid  subtype,
Oid  collation,
FmgrInfo *  finfo,
Datum  argument 
)

Definition at line 101 of file scankey.c.

References CurrentMemoryContext, fmgr_info_copy(), ScanKeyData::sk_argument, ScanKeyData::sk_attno, ScanKeyData::sk_collation, ScanKeyData::sk_flags, ScanKeyData::sk_func, ScanKeyData::sk_strategy, and ScanKeyData::sk_subtype.

Referenced by _bt_first(), _bt_mkscankey(), and _bt_mkscankey_nodata().

109 {
110  entry->sk_flags = flags;
111  entry->sk_attno = attributeNumber;
112  entry->sk_strategy = strategy;
113  entry->sk_subtype = subtype;
114  entry->sk_collation = collation;
115  entry->sk_argument = argument;
116  fmgr_info_copy(&entry->sk_func, finfo, CurrentMemoryContext);
117 }
ScanKeyData::sk_subtype
Oid sk_subtype
Definition: skey.h:69
ScanKeyData::sk_strategy
StrategyNumber sk_strategy
Definition: skey.h:68
fmgr_info_copy
void fmgr_info_copy(FmgrInfo *dstinfo, FmgrInfo *srcinfo, MemoryContext destcxt)
Definition: fmgr.c:609
ScanKeyData::sk_func
FmgrInfo sk_func
Definition: skey.h:71
CurrentMemoryContext
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
ScanKeyData::sk_flags
int sk_flags
Definition: skey.h:66
ScanKeyData::sk_collation
Oid sk_collation
Definition: skey.h:70
ScanKeyData::sk_argument
Datum sk_argument
Definition: skey.h:72
ScanKeyData::sk_attno
AttrNumber sk_attno
Definition: skey.h:67

◆ ScanKeyInit()

void ScanKeyInit ( ScanKey  entry,
AttrNumber  attributeNumber,
StrategyNumber  strategy,
RegProcedure  procedure,
Datum  argument 
)

Definition at line 76 of file scankey.c.

References fmgr_info(), InvalidOid, ScanKeyData::sk_argument, ScanKeyData::sk_attno, ScanKeyData::sk_collation, ScanKeyData::sk_flags, ScanKeyData::sk_func, ScanKeyData::sk_strategy, and ScanKeyData::sk_subtype.

Referenced by AfterTriggerSetState(), AlterConstraintNamespaces(), AlterDatabase(), AlterDatabaseOwner(), AlterDomainDropConstraint(), AlterDomainValidateConstraint(), AlterExtensionNamespace(), AlterPolicy(), AlterSeqNamespaces(), AlterSetting(), AlterTableMoveAll(), AlterTableSpaceOptions(), ApplyExtensionUpdates(), ApplySetting(), ATExecAddOf(), ATExecAlterColumnType(), ATExecAlterConstraint(), ATExecAttachPartition(), ATExecDropConstraint(), ATExecValidateConstraint(), ATPrepChangePersistence(), AttrDefaultFetch(), build_replindex_scan_key(), change_owner_fix_column_acls(), change_owner_recurse_to_sequences(), changeDependencyFor(), CheckConstraintFetch(), checkSharedDependencies(), ChooseConstraintName(), CloneForeignKeyConstraints(), CloneRowTriggersToPartition(), ConstraintNameIsUsed(), copyTemplateDependencies(), CountDBSubscriptions(), CreateComments(), CreateInheritance(), CreatePolicy(), CreateSharedComments(), CreateTrigger(), DefineOpClass(), DefineTSConfiguration(), DeleteAttributeTuples(), DeleteComments(), deleteDependencyRecordsFor(), deleteDependencyRecordsForClass(), DeleteInheritsTuple(), DeleteInitPrivs(), deleteOneObject(), DeleteSecurityLabel(), DeleteSharedComments(), DeleteSharedSecurityLabel(), DeleteSystemAttributeTuples(), do_autovacuum(), drop_parent_dependency(), DropCastById(), DropConfigurationMapping(), dropDatabaseDependencies(), DropRole(), DropSetting(), DropTableSpace(), DropTransformById(), EnableDisableTrigger(), enum_endpoint(), enum_range_internal(), EnumValuesDelete(), ExecAlterExtensionStmt(), ExecGrant_Largeobject(), extension_config_remove(), fetch_statentries_for_relation(), find_composite_type_dependencies(), find_inheritance_children(), find_language_template(), find_typed_table_dependencies(), findDependentObjects(), get_catalog_object_by_oid(), get_constraint_index(), get_database_oid(), get_db_info(), get_domain_constraint_oid(), get_extension_name(), get_extension_oid(), get_extension_schema(), get_index_constraint(), get_object_address_attrdef(), get_partition_parent_worker(), get_pkey_attnames(), get_primary_key_attnos(), get_relation_constraint_attnos(), get_relation_constraint_oid(), get_relation_idx_constraint_oid(), get_relation_policy_oid(), get_rels_with_domain(), get_tables_to_cluster(), get_tablespace_name(), get_tablespace_oid(), get_trigger_oid(), GetAllTablesPublicationRelations(), GetAllTablesPublications(), GetComment(), GetDatabaseTuple(), GetDatabaseTupleByOid(), GetDefaultOpClass(), getExtensionOfObject(), GetNewOidWithIndex(), getObjectDescription(), getObjectIdentityParts(), getOwnedSequences(), GetPublicationRelations(), getRelationsInNamespace(), GetSecurityLabel(), GetSharedSecurityLabel(), GetSubscriptionNotReadyRelations(), GetSubscriptionRelations(), has_superclass(), index_update_stats(), IndexSetParentIndex(), inv_getsize(), inv_read(), inv_truncate(), inv_write(), isObjectPinned(), isSharedObjectPinned(), LargeObjectDrop(), LargeObjectExists(), load_domaintype_info(), load_enum_cache_data(), lookup_ts_config_cache(), LookupOpclassInfo(), makeConfigurationDependencies(), MakeConfigurationMapping(), MergeConstraintsIntoExisting(), MergeWithExistingConstraint(), movedb(), myLargeObjectExists(), objectsInSchemaToOids(), pg_extension_config_dump(), pg_extension_ownercheck(), pg_get_constraintdef_worker(), pg_get_serial_sequence(), pg_get_triggerdef_worker(), pg_largeobject_aclmask_snapshot(), pg_largeobject_ownercheck(), RangeDelete(), recordExtensionInitPrivWorker(), recordExtObjInitPriv(), refuseDupeIndexAttach(), ReindexMultipleTables(), relation_has_policies(), RelationBuildRowSecurity(), RelationBuildRuleLock(), RelationBuildTriggers(), RelationBuildTupleDesc(), RelationGetExclusionInfo(), RelationGetFKeyList(), RelationGetIndexList(), RelationGetStatExtList(), RelationRemoveInheritance(), RemoveAmOpEntryById(), RemoveAmProcEntryById(), RemoveAttrDefault(), RemoveAttrDefaultById(), RemoveCollationById(), RemoveConversionById(), RemoveDefaultACLById(), RemoveExtensionById(), RemoveInheritance(), RemovePolicyById(), RemoveRewriteRuleById(), RemoveRoleFromObjectACL(), RemoveRoleFromObjectPolicy(), RemoveStatistics(), RemoveSubscriptionRel(), RemoveTriggerById(), RemoveTSConfigurationById(), rename_policy(), RenameTableSpace(), renametrig(), replorigin_create(), ScanPgRelation(), sepgsql_attribute_post_create(), sepgsql_database_post_create(), sepgsql_proc_post_create(), sepgsql_proc_setattr(), sepgsql_relation_post_create(), sepgsql_relation_setattr(), sepgsql_relation_setattr_extra(), sepgsql_schema_post_create(), sequenceIsOwned(), SetSecurityLabel(), SetSharedSecurityLabel(), shdepChangeDep(), shdepDropDependency(), shdepDropOwned(), shdepReassignOwned(), toast_delete_datum(), toast_fetch_datum(), toast_fetch_datum_slice(), toastrel_valueid_exists(), typeInheritsFrom(), and validatePartitionedIndex().

81 {
82  entry->sk_flags = 0;
83  entry->sk_attno = attributeNumber;
84  entry->sk_strategy = strategy;
85  entry->sk_subtype = InvalidOid;
86  entry->sk_collation = DEFAULT_COLLATION_OID;
87  entry->sk_argument = argument;
88  fmgr_info(procedure, &entry->sk_func);
89 }
ScanKeyData::sk_subtype
Oid sk_subtype
Definition: skey.h:69
fmgr_info
void fmgr_info(Oid functionId, FmgrInfo *finfo)
Definition: fmgr.c:123
ScanKeyData::sk_strategy
StrategyNumber sk_strategy
Definition: skey.h:68
ScanKeyData::sk_func
FmgrInfo sk_func
Definition: skey.h:71
InvalidOid
#define InvalidOid
Definition: postgres_ext.h:36
ScanKeyData::sk_flags
int sk_flags
Definition: skey.h:66
ScanKeyData::sk_collation
Oid sk_collation
Definition: skey.h:70
ScanKeyData::sk_argument
Datum sk_argument
Definition: skey.h:72
ScanKeyData::sk_attno
AttrNumber sk_attno
Definition: skey.h:67