Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

catalog: string
cncString: string
gTypeInstance: TypeInstance
parentInstance: GObject.Object
schema: string
name: string

Methods

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • connect(sigName: "meta-changed", callback: Gda.MetaStore_MetaChangedSignalCallback): number
  • connect(sigName: "meta-reset", callback: Gda.MetaStore_MetaResetSignalCallback): number
  • connect(sigName: "suggest-update", callback: Gda.MetaStore_SuggestUpdateSignalCallback): number
  • connect(sigName: "notify::catalog", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::cnc", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::cnc-string", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::schema", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Creates a new #GdaDataModelArray data model which can be used, after being correctly filled, with the gda_meta_store_modify*() methods.*

    To be used by provider's implementation

    Parameters

    • tableName: string

      the name of a table present in store

    Returns Gda.DataModel

  • declareForeignKey(mstruct: Gda.MetaStruct, fkName: string, catalog: string, schema: string, table: string, refCatalog: string, refSchema: string, refTable: string, colnames: string[], refColnames: string[]): boolean
  • Defines a new declared foreign key into store. If another declared foreign key is already defined between the two tables and with the same name, then it is first removed.

    This method begins a transaction if possible (ie. none is already started), and if it can't, then if there is an error, the job may be partially done.

    A check is always performed to make sure all the database objects actually exist and returns an error if not. The check is performed using mstruct if it's not %NULL (in this case only the tables already represented in mstruct will be considered, in other words: mstruct will not be modified), and using an internal #GdaMetaStruct is %NULL.

    The catalog, schema, table, ref_catalog, ref_schema and ref_table must follow the SQL identifiers naming convention, see the SQL identifiers section. The same convention needs to be respected for the strings in conames and ref_colnames.

    If catalog is not %NULL, then schema must also be not %NULL (the same restriction applies to ref_catalog and ref_schema).

    Parameters

    • mstruct: Gda.MetaStruct

      a #GdaMetaStruct, or %NULL

    • fkName: string

      the name of the foreign key to declare

    • catalog: string

      the catalog in which the table (for which the foreign key is for) is, or %NULL

    • schema: string

      the schema in which the table (for which the foreign key is for) is, or %NULL

    • table: string

      the name of the table (for which the foreign key is for)

    • refCatalog: string

      the catalog in which the referenced table is, or %NULL

    • refSchema: string

      the schema in which the referenced table is, or %NULL

    • refTable: string

      the name of the referenced table

    • colnames: string[]

      an array of column names from the table for which the foreign key is for

    • refColnames: string[]

      an array of column names from the referenced table

    Returns boolean

  • emit(sigName: "meta-changed", ...args: any[]): void
  • emit(sigName: "meta-reset", ...args: any[]): void
  • emit(sigName: "suggest-update", ...args: any[]): void
  • emit(sigName: "notify::catalog", ...args: any[]): void
  • emit(sigName: "notify::cnc", ...args: any[]): void
  • emit(sigName: "notify::cnc-string", ...args: any[]): void
  • emit(sigName: "notify::schema", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Parameters

    • sigName: "meta-changed"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "meta-reset"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "suggest-update"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::catalog"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::cnc"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::cnc-string"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::schema"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: string
    • Rest ...args: any[]

    Returns void

  • extract(selectSql: string, vars: HashTable<string | number | symbol, string | number | boolean>): Gda.DataModel
  • Extracts some data stored in store using a custom SELECT query. If the select_sql filter involves SQL identifiers (such as table or column names), then the values should have been adapted using gda_meta_store_sql_identifier_quote().

    For more information about SQL identifiers are represented in store, see the

    meta data section about SQL identifiers.

    Parameters

    • selectSql: string

      a SELECT statement

    • vars: HashTable<string | number | symbol, string | number | boolean>

      a hash table with all variables names as keys and GValue* as value, representing values for all the variables mentioned in select_sql. If there is no variable then this part can be omitted.

    Returns Gda.DataModel

  • forceFloating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freezeNotify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • getAttributeValue(attName: string): [boolean, string]
  • The #GdaMetaStore object maintains a list of (name,value) attributes (attributes names starting with a '_' character are for internal use only and cannot be altered). This method and the gda_meta_store_set_attribute_value() method allows the user to add, set or remove attributes specific to their usage.

    This method allows to get the value of a attribute stored in store. The returned attribute value is placed at att_value, the caller is responsible for free that string.

    If there is no attribute named att_name then att_value is set to %NULL and error will contain the GDA_META_STORE_ATTRIBUTE_NOT_FOUND_ERROR error code, and FALSE is returned.

    Parameters

    • attName: string

      name of the attribute to get

    Returns [boolean, string]

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • Get a pointer to the #GdaConnection object internally used by store to store its contents.

    The returned connection can be used to access some other data than the one managed by store itself. The returned object is not owned by the caller (if you need to keep it, then use g_object_ref()). Do not close the connection.

    Returns Gda.Connection

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getVersion(): number
  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • isFloating(): boolean
  • modify(tableName: string, newData: Gda.DataModel, condition: string, valueNames: string[], values: any[]): boolean
  • Propagates an update to store, the update's contents is represented by new_data, this function is primarily reserved to database providers.

    Parameters

    • tableName: string

      the name of the table to modify within store

    • newData: Gda.DataModel

      a #GdaDataModel containing the new data to set in table_name, or %NULL (treated as a data model with no row at all)

    • condition: string

      SQL expression (which may contain variables) defining the rows which are being obsoleted by new_data, or %NULL

    • valueNames: string[]

      names of values

    • values: any[]

      values

    Returns boolean

  • Propagates an update to store, the update's contents is represented by new_data, this function is primarily reserved to database providers.

    Parameters

    • context: Gda.MetaContext

      a #GdaMetaContext context describing what to modify in store

    • newData: Gda.DataModel

      a #GdaDataModel containing the new data to set in table_name, or %NULL (treated as a data model with no row at all)

    Returns boolean

  • notify(propertyName: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: "meta-changed", callback: Gda.MetaStore_MetaChangedSignalCallback): EventEmitter
  • off(sigName: "meta-reset", callback: Gda.MetaStore_MetaResetSignalCallback): EventEmitter
  • off(sigName: "suggest-update", callback: Gda.MetaStore_SuggestUpdateSignalCallback): EventEmitter
  • off(sigName: "notify::catalog", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::cnc", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::cnc-string", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::schema", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::catalog"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cnc"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cnc-string"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::schema"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "meta-changed", callback: Gda.MetaStore_MetaChangedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "meta-reset", callback: Gda.MetaStore_MetaResetSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "suggest-update", callback: Gda.MetaStore_SuggestUpdateSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "notify::catalog", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::cnc", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::cnc-string", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::schema", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::catalog"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cnc"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cnc-string"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::schema"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "meta-changed", callback: Gda.MetaStore_MetaChangedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "meta-reset", callback: Gda.MetaStore_MetaResetSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "suggest-update", callback: Gda.MetaStore_SuggestUpdateSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "notify::catalog", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::cnc", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::cnc-string", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::schema", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::catalog"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cnc"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::cnc-string"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::schema"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • schemaAddCustomObject(xmlDescription: string): boolean
  • The internal database used by store can be 'augmented' with some user-defined database objects (such as tables or views). This method allows one to add a new database object.

    If the internal database already contains the object, then: if the object is equal to the provided description then TRUE is returned if the object exists but differs from the provided description, then FALSE is returned, with the GDA_META_STORE_SCHEMA_OBJECT_CONFLICT_ERROR error code

    The xml_description defines the table of view's definition, for example: <![CDATA[

    ]]>

    The partial DTD for this XML description of the object to add is the following (the top node must be a <table> or a <view>): <![CDATA[

    ]]>

    Parameters

    • xmlDescription: string

      an XML description of the table or view to add to store

    Returns boolean

  • schemaGetAllTables(): string[]
  • Get an ordered list of the tables store knows about. The tables are ordered in a way that tables dependencies are respected: if table B has a foreign key on table A, then table A will be listed before table B in the returned list.

    Returns string[]

  • schemaGetDependTables(tableName: string): string[]
  • Get an ordered list of the tables store knows about on which the table_name table depends (recursively). The tables are ordered in a way that tables dependencies are respected: if table B has a foreign key on table A, then table A will be listed before table B in the returned list.

    Parameters

    • tableName: string

      the name of the table for which all the dependencies must be listed

    Returns string[]

  • schemaRemoveCustomObject(objName: string): boolean
  • Removes the custom database object named obj_name.

    Parameters

    • objName: string

      name of the custom object to remove

    Returns boolean

  • setAttributeValue(attName: string, attValue: string): boolean
  • Set the value of the attribute named att_name to att_value; see gda_meta_store_get_attribute_value() for more information.

    Parameters

    • attName: string

      name of the attribute to set

    • attValue: string

      value of the attribute to set, or %NULL to unset the attribute

    Returns boolean

  • setData(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • Specifies how store must handle SQL identifiers it has to store. This method is mainly used by database providers.

    Parameters

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • Specifies a function which store will use to determine if a keyword is an SQL reserved keyword or not.

    This method is mainly used by database providers.

    Parameters

    Returns void

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • undeclareForeignKey(mstruct: Gda.MetaStruct, fkName: string, catalog: string, schema: string, table: string, refCatalog: string, refSchema: string, refTable: string): boolean
  • Removes a declared foreign key from store.

    This method begins a transaction if possible (ie. none is already started), and if it can't, then if there is an error, the job may be partially done.

    A check is always performed to make sure all the database objects actually exist and returns an error if not. The check is performed using mstruct if it's not %NULL (in this case only the tables already represented in mstruct will be considered, in other words: mstruct will not be modified), and using an internal #GdaMetaStruct is %NULL.

    See gda_meta_store_declare_foreign_key() for more information anout the catalog, schema, name, ref_catalog, ref_schema and ref_name arguments.

    Parameters

    • mstruct: Gda.MetaStruct

      a #GdaMetaStruct, or %NULL

    • fkName: string

      the name of the foreign key to declare

    • catalog: string

      the catalog in which the table (for which the foreign key is for) is, or %NULL

    • schema: string

      the schema in which the table (for which the foreign key is for) is, or %NULL

    • table: string

      the name of the table (for which the foreign key is for)

    • refCatalog: string

      the catalog in which the referenced table is, or %NULL

    • refSchema: string

      the schema in which the referenced table is, or %NULL

    • refTable: string

      the name of the referenced table

    Returns boolean

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • errorQuark(): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Create a new #GdaMetaStore object.

    Parameters

    • cncString: string

      a connection string, or %NULL for an in-memory internal database

    Returns Gda.MetaStore

  • Create a new #GdaMetaStore object using file_name as its internal database

    Parameters

    • fileName: string

      a file name

    Returns Gda.MetaStore

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

  • Use this method to get a correctly quoted (if necessary) SQL identifier which can be used to retrieve or filter information in a #GdaMetaStore which stores meta data about cnc.

    The returned SQL identifier can be used in conjunction with gda_connection_update_meta_store(), gda_connection_get_meta_store_data(), gda_connection_get_meta_store_data_v() and gda_meta_store_extract().

    Parameters

    • id: string

      an SQL identifier

    • cnc: Gda.Connection

      a #GdaConnection

    Returns string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method