Skip to content

Commit f1a22cf

Browse files
committed
clarify constant values
1 parent 716740b commit f1a22cf

File tree

2 files changed

+32
-0
lines changed
  • c/include/arrow-adbc
  • go/adbc/drivermgr/arrow-adbc

2 files changed

+32
-0
lines changed

c/include/arrow-adbc/adbc.h

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -577,46 +577,62 @@ const struct AdbcError* AdbcErrorFromArrayStream(struct ArrowArrayStream* stream
577577
/// \brief This foreign key does not allow update of the corresponding primary
578578
/// key.
579579
///
580+
/// \note Value corresponds to JDBC `DatabaseMetaData#importedKeyNoAction`.
581+
///
580582
/// \see AdbcConnectionGetObjects
581583
#define ADBC_CONSTRAINT_ACTION_NO_ACTION 3
582584

583585
/// \brief This foreign key will be updated/deleted with corresponding primary
584586
/// key.
585587
///
588+
/// \note Value corresponds to JDBC `DatabaseMetaData#importedKeyCascade`.
589+
///
586590
/// \see AdbcConnectionGetObjects
587591
#define ADBC_CONSTRAINT_ACTION_CASCADE 0
588592

589593
/// \brief This foreign key will be set to NULL if its corresponding primary
590594
/// key is updated or deleted.
591595
///
596+
/// \note Value corresponds to JDBC `DatabaseMetaData#importedKeySetNull`.
597+
///
592598
/// \see AdbcConnectionGetObjects
593599
#define ADBC_CONSTRAINT_ACTION_SET_NULL 2
594600

595601
/// \brief This foreign key will be set to its default if its corresponding
596602
/// primary key is updated or deleted.
597603
///
604+
/// \note Value corresponds to JDBC `DatabaseMetaData#importedKeySetDefault`.
605+
///
598606
/// \see AdbcConnectionGetObjects
599607
#define ADBC_CONSTRAINT_ACTION_SET_DEFAULT 4
600608

601609
/// \brief Similar to ADBC_CONSTRAINT_ACTION_NO_ACTION but may be interpreted
602610
/// differently by the vendor (e.g., raise an error immediately instead of
603611
/// allowing the check to be deferred).
604612
///
613+
/// \note Value corresponds to JDBC `DatabaseMetaData#importedKeyRestrict`.
614+
///
605615
/// \see AdbcConnectionGetObjects
606616
#define ADBC_CONSTRAINT_ACTION_RESTRICT 1
607617

608618
/// \brief This constraint is deferrable, and is initially deferred.
609619
///
620+
/// \note Value corresponds to JDBC `DatabaseMetaData#importedKeyInitiallyDeferred`.
621+
///
610622
/// \see AdbcConnectionGetObjects
611623
#define ADBC_CONSTRAINT_DEFERRABLE_DEFERRED 5
612624

613625
/// \brief This constraint is deferrable, but is initially immediate.
614626
///
627+
/// \note Value corresponds to JDBC `DatabaseMetaData#importedKeyInitiallyImmediate`.
628+
///
615629
/// \see AdbcConnectionGetObjects
616630
#define ADBC_CONSTRAINT_DEFERRABLE_IMMEDIATE 6
617631

618632
/// \brief This constraint may not be deferred.
619633
///
634+
/// \note Value corresponds to JDBC `DatabaseMetaData#importedKeyNotDeferrable`.
635+
///
620636
/// \see AdbcConnectionGetObjects
621637
#define ADBC_CONSTRAINT_NOT_DEFERRABLE 7
622638

go/adbc/drivermgr/arrow-adbc/adbc.h

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)