GdaDdlView

GdaDdlView — Object to represent view database object

Stability Level

Stable, unless otherwise indicated

Functions

GdaDdlView * gda_ddl_view_new ()
GdaDdlView * gda_ddl_view_new_from_meta ()
void gda_ddl_view_free ()
gboolean gda_ddl_view_get_istemp ()
void gda_ddl_view_set_istemp ()
gboolean gda_ddl_view_get_ifnoexist ()
void gda_ddl_view_set_ifnoexist ()
const gchar * gda_ddl_view_get_defstring ()
void gda_ddl_view_set_defstring ()
gboolean gda_ddl_view_get_replace ()
void gda_ddl_view_set_replace ()
gboolean gda_ddl_view_create ()
gboolean gda_ddl_view_prepare_create ()

Properties

gchar * defstring Read / Write
gboolean ifnoexist Read / Write
gboolean istemp Read / Write
gboolean replace Read / Write

Types and Values

#define GDA_TYPE_DDL_VIEW
struct GdaDdlViewClass
  GdaDdlView

Object Hierarchy

    GObject
    ╰── GdaDdlBase
        ╰── GdaDdlView

Implemented Interfaces

GdaDdlView implements GdaDdlBuildable.

Includes

#include <libgda/libgda.h>

Description

This object represents a view of a database. The view can be constracted manually using API or generated from xml file together with other databse objects. See GdaDdlCreator. GdaDdlView implements GdaDdlBuildable interface for parsing xml file.

Functions

gda_ddl_view_new ()

GdaDdlView *
gda_ddl_view_new (void);

Returns

A new instance of GdaDdlView. Use gda_ddl_view_free() to delete the object and free the memory.

Since: 6.0

gda_ddl_view_new_from_meta ()

GdaDdlView *
gda_ddl_view_new_from_meta (GdaMetaView *view);

Create new GdaDdlView object from the corresponding GdaMetaView object

Parameters

view

a GdaMetaView instance

  

Returns

New instance of GdaDdlView

gda_ddl_view_free ()

void
gda_ddl_view_free (GdaDdlView *self);

Convenient method to fdelete the object and free the memory.

Parameters

self

a GdaDdlView object

  

Since: 6.0

gda_ddl_view_get_istemp ()

gboolean
gda_ddl_view_get_istemp (GdaDdlView *self);

Parameters

self

a GdaDdlView object

  

Returns

TRUE if the view is temporary, FALSE otherwise

Since: 6.0

gda_ddl_view_set_istemp ()

void
gda_ddl_view_set_istemp (GdaDdlView *self,
                         gboolean temp);

Parameters

self

a GdaDdlView object

  

temp

value to set

  

Since: 6.0

gda_ddl_view_get_ifnoexist ()

gboolean
gda_ddl_view_get_ifnoexist (GdaDdlView *self);

Parameters

self

a GdaDdlView object

  

Returns

TRUE if th view should be created with "IF NOT EXISTS" key, FALSE otherwise

Since: 6.0

gda_ddl_view_set_ifnoexist ()

void
gda_ddl_view_set_ifnoexist (GdaDdlView *self,
                            gboolean noexist);

Parameters

self

a GdaDdlView object

  

noexist

a value to set

  

Since: 6.0

gda_ddl_view_get_defstring ()

const gchar *
gda_ddl_view_get_defstring (GdaDdlView *self);

Parameters

self

a GdaDdlView object

  

Returns

view definition string Sinc: 6.0

gda_ddl_view_set_defstring ()

void
gda_ddl_view_set_defstring (GdaDdlView *self,
                            const gchar *str);

Parameters

self

a GdaDdlView object

  

str

view definition string to set. Should be valid SQL string

  

Since: 6.0

gda_ddl_view_get_replace ()

gboolean
gda_ddl_view_get_replace (GdaDdlView *self);

Parameters

self

a GdaDdlView object

  

Returns

TRUE if the current view should replace the existing one in the database, FALSE otherwise.

Since: 6.0

gda_ddl_view_set_replace ()

void
gda_ddl_view_set_replace (GdaDdlView *self,
                          gboolean replace);

Parameters

self

a GdaDdlView object

  

replace

a value to set

  

Since: 6.0

gda_ddl_view_create ()

gboolean
gda_ddl_view_create (GdaDdlView *self,
                     GdaConnection *cnc,
                     GError **error);

This method performs CREATE_VIEW operation over cnc using data stored in self It is a convenient method to perform operation. See gda_ddl_view_prepare_create() if better flexibility is needed.

Parameters

self

a GdaDdlView instance

  

cnc

open connection for the operation

  

error

error container

  

Returns

TRUE if no error, FASLE otherwise

Since: 6.0

gda_ddl_view_prepare_create ()

gboolean
gda_ddl_view_prepare_create (GdaDdlView *self,
                             GdaServerOperation *op,
                             GError **error);

Populate op with information needed to perform CREATE_VIEW operation.

Parameters

self

a GdaDdlView instance

  

op

GdaServerOperation instance to populate

  

error

error container

  

Returns

TRUE if succeeded and FALSE otherwise.

Types and Values

GDA_TYPE_DDL_VIEW

#define GDA_TYPE_DDL_VIEW (gda_ddl_view_get_type())

struct GdaDdlViewClass

struct GdaDdlViewClass {
  GdaDdlBaseClass parent_class;
};

GdaDdlView

typedef struct _GdaDdlView GdaDdlView;

Property Details

The “defstring” property

  “defstring”                gchar *

Define view.

Flags: Read / Write

Default value: NULL

The “ifnoexist” property

  “ifnoexist”                gboolean

Create view if it doesn't exist.

Flags: Read / Write

Default value: FALSE

The “istemp” property

  “istemp”                   gboolean

Set if view is temp.

Flags: Read / Write

Default value: FALSE

The “replace” property

  “replace”                  gboolean

Set if view should be repalced.

Flags: Read / Write

Default value: TRUE

See Also

GdaDdlTable, GdaDdlCreator

Generated by GTK-Doc V1.27