Top | ![]() |
![]() |
![]() |
![]() |
GdaDbIndexField * | gda_db_index_field_new () |
void | gda_db_index_field_set_column () |
GdaDbColumn * | gda_db_index_field_get_column () |
void | gda_db_index_field_set_collate () |
const gchar * | gda_db_index_field_get_collate () |
void | gda_db_index_field_set_sort_order () |
GdaDbIndexSortOrder | gda_db_index_field_get_sort_order () |
const gchar * | gda_db_index_field_get_sort_order_str () |
This object is a container for information needed to create an index for a table. After population with information, it should be passed to the GdaDbIndex instance. See GdaDbIndex section for the example.
GdaDbIndexField *
gda_db_index_field_new (void
);
Create a new instance of GdaDbIndexField
Since: 6.0
Stability Level: Stable
void gda_db_index_field_set_column (GdaDbIndexField *self
,GdaDbColumn *column
);
Only full name will be extracted from column
. The column
instance should be freed using
g_object_unref()
. The instance self
take a copy of the column
object by increasing its
referecne count.
Since: 6.0
Stability Level: Stable
GdaDbColumn *
gda_db_index_field_get_column (GdaDbIndexField *self
);
Returns an active column that was asigned to GdaDbIndexField instance
Since: 6.0
Stability Level: Stable
void gda_db_index_field_set_collate (GdaDbIndexField *self
,const gchar *collate
);
Unfortunately, collate can vary from provider to provider. This method accepts collate name as a string but user should provide valid values. For instance, SQLite3 accepts only "BINARY", "NOCASE", and "RTRIM" values. PostgreSQL, on the other hand expects a name of a callable object, e.g. function.
Since: 6.0
Stability Level: Stable
const gchar *
gda_db_index_field_get_collate (GdaDbIndexField *self
);
Since: 6.0
Stability Level: Stable
void gda_db_index_field_set_sort_order (GdaDbIndexField *self
,GdaDbIndexSortOrder sorder
);
Since: 6.0
Stability Level: Stable
GdaDbIndexSortOrder
gda_db_index_field_get_sort_order (GdaDbIndexField *self
);
Since: 6.0
Stability Level: Stable
const gchar *
gda_db_index_field_get_sort_order_str (GdaDbIndexField *self
);
Since: 6.0
Stability Level: Stable