pg_largeobject.h File Reference

#include "catalog/genbki.h"
#include "catalog/pg_largeobject_d.h"
#include "utils/snapshot.h"

Include dependency graph for pg_largeobject.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef FormData_pg_largeobject *	Form_pg_largeobject

Functions
	CATALOG (pg_largeobject, 2613, LargeObjectRelationId)
	DECLARE_UNIQUE_INDEX_PKEY (pg_largeobject_loid_pn_index, 2683, LargeObjectLOidPNIndexId, pg_largeobject, btree(loid oid_ops, pageno int4_ops))
Oid	LargeObjectCreate (Oid loid)
void	LargeObjectDrop (Oid loid)
bool	LargeObjectExists (Oid loid)
bool	LargeObjectExistsWithSnapshot (Oid loid, Snapshot snapshot)

Variables
	FormData_pg_largeobject

Typedef Documentation

Form_pg_largeobject

typedef FormData_pg_largeobject* Form_pg_largeobject

Definition at line 46 of file pg_largeobject.h.

Function Documentation

CATALOG()

CATALOG	(	pg_largeobject	,
		2613	,
		LargeObjectRelationId
	)

Definition at line 30 of file pg_largeobject.h.

{
    Oid         loid BKI_LOOKUP(pg_largeobject_metadata);   /* Identifier of large
                                                             * object */
    int32       pageno;         /* Page number (starting from 0) */
 
    /* data has variable length, but we allow direct access; see inv_api.c */
    bytea       data BKI_FORCE_NOT_NULL;    /* Data for page (may be
                                             * zero-length) */
} FormData_pg_largeobject;

References BKI_FORCE_NOT_NULL, BKI_LOOKUP, and data.

DECLARE_UNIQUE_INDEX_PKEY()

DECLARE_UNIQUE_INDEX_PKEY	(	pg_largeobject_loid_pn_index	,
		2683	,
		LargeObjectLOidPNIndexId	,
		pg_largeobject	,
		btree(loid oid_ops, pageno int4_ops)
	)

LargeObjectCreate()

Oid LargeObjectCreate

(

Oid

loid

)

Definition at line 37 of file pg_largeobject.c.

{
    Relation    pg_lo_meta;
    HeapTuple   ntup;
    Oid         loid_new;
    Datum       values[Natts_pg_largeobject_metadata];
    bool        nulls[Natts_pg_largeobject_metadata];
    Oid         ownerId;
    Acl        *lomacl;
 
    pg_lo_meta = table_open(LargeObjectMetadataRelationId,
                            RowExclusiveLock);
 
    /*
     * Insert metadata of the largeobject
     */
    memset(values, 0, sizeof(values));
    memset(nulls, false, sizeof(nulls));
 
    if (OidIsValid(loid))
        loid_new = loid;
    else
        loid_new = GetNewOidWithIndex(pg_lo_meta,
                                      LargeObjectMetadataOidIndexId,
                                      Anum_pg_largeobject_metadata_oid);
    ownerId = GetUserId();
    lomacl = get_user_default_acl(OBJECT_LARGEOBJECT, ownerId, InvalidOid);
 
    values[Anum_pg_largeobject_metadata_oid - 1] = ObjectIdGetDatum(loid_new);
    values[Anum_pg_largeobject_metadata_lomowner - 1]
        = ObjectIdGetDatum(ownerId);
 
    if (lomacl != NULL)
        values[Anum_pg_largeobject_metadata_lomacl - 1]
            = PointerGetDatum(lomacl);
    else
        nulls[Anum_pg_largeobject_metadata_lomacl - 1] = true;
 
    ntup = heap_form_tuple(RelationGetDescr(pg_lo_meta),
                           values, nulls);
 
    CatalogTupleInsert(pg_lo_meta, ntup);
 
    heap_freetuple(ntup);
 
    table_close(pg_lo_meta, RowExclusiveLock);
 
    /* dependencies on roles mentioned in default ACL */
    recordDependencyOnNewAcl(LargeObjectRelationId, loid_new, 0,
                             ownerId, lomacl);
 
    return loid_new;
}

References CatalogTupleInsert(), get_user_default_acl(), GetNewOidWithIndex(), GetUserId(), heap_form_tuple(), heap_freetuple(), InvalidOid, OBJECT_LARGEOBJECT, ObjectIdGetDatum(), OidIsValid, PointerGetDatum(), recordDependencyOnNewAcl(), RelationGetDescr, RowExclusiveLock, table_close(), table_open(), and values.

Referenced by inv_create().

LargeObjectDrop()

void LargeObjectDrop

(

Oid

loid

)

Definition at line 96 of file pg_largeobject.c.

{
    Relation    pg_lo_meta;
    Relation    pg_largeobject;
    ScanKeyData skey[1];
    SysScanDesc scan;
    HeapTuple   tuple;
 
    pg_lo_meta = table_open(LargeObjectMetadataRelationId,
                            RowExclusiveLock);
 
    pg_largeobject = table_open(LargeObjectRelationId,
                                RowExclusiveLock);
 
    /*
     * Delete an entry from pg_largeobject_metadata
     */
    ScanKeyInit(&skey[0],
                Anum_pg_largeobject_metadata_oid,
                BTEqualStrategyNumber, F_OIDEQ,
                ObjectIdGetDatum(loid));
 
    scan = systable_beginscan(pg_lo_meta,
                              LargeObjectMetadataOidIndexId, true,
                              NULL, 1, skey);
 
    tuple = systable_getnext(scan);
    if (!HeapTupleIsValid(tuple))
        ereport(ERROR,
                (errcode(ERRCODE_UNDEFINED_OBJECT),
                 errmsg("large object %u does not exist", loid)));
 
    CatalogTupleDelete(pg_lo_meta, &tuple->t_self);
 
    systable_endscan(scan);
 
    /*
     * Delete all the associated entries from pg_largeobject
     */
    ScanKeyInit(&skey[0],
                Anum_pg_largeobject_loid,
                BTEqualStrategyNumber, F_OIDEQ,
                ObjectIdGetDatum(loid));
 
    scan = systable_beginscan(pg_largeobject,
                              LargeObjectLOidPNIndexId, true,
                              NULL, 1, skey);
    while (HeapTupleIsValid(tuple = systable_getnext(scan)))
    {
        CatalogTupleDelete(pg_largeobject, &tuple->t_self);
    }
 
    systable_endscan(scan);
 
    table_close(pg_largeobject, RowExclusiveLock);
 
    table_close(pg_lo_meta, RowExclusiveLock);
}

References BTEqualStrategyNumber, CatalogTupleDelete(), ereport, errcode(), errmsg(), ERROR, HeapTupleIsValid, ObjectIdGetDatum(), RowExclusiveLock, ScanKeyInit(), systable_beginscan(), systable_endscan(), systable_getnext(), HeapTupleData::t_self, table_close(), and table_open().

Referenced by doDeletion().

LargeObjectExists()

bool LargeObjectExists

(

Oid

loid

)

Definition at line 168 of file pg_largeobject.c.

{
    return LargeObjectExistsWithSnapshot(loid, NULL);
}

References LargeObjectExistsWithSnapshot().

Referenced by be_lo_unlink(), get_object_address(), getObjectDescription(), and getObjectIdentityParts().

LargeObjectExistsWithSnapshot()

bool LargeObjectExistsWithSnapshot	(	Oid	loid,
		Snapshot	snapshot
	)

Definition at line 177 of file pg_largeobject.c.

{
    Relation    pg_lo_meta;
    ScanKeyData skey[1];
    SysScanDesc sd;
    HeapTuple   tuple;
    bool        retval = false;
 
    ScanKeyInit(&skey[0],
                Anum_pg_largeobject_metadata_oid,
                BTEqualStrategyNumber, F_OIDEQ,
                ObjectIdGetDatum(loid));
 
    pg_lo_meta = table_open(LargeObjectMetadataRelationId,
                            AccessShareLock);
 
    sd = systable_beginscan(pg_lo_meta,
                            LargeObjectMetadataOidIndexId, true,
                            snapshot, 1, skey);
 
    tuple = systable_getnext(sd);
    if (HeapTupleIsValid(tuple))
        retval = true;
 
    systable_endscan(sd);
 
    table_close(pg_lo_meta, AccessShareLock);
 
    return retval;
}

References AccessShareLock, BTEqualStrategyNumber, HeapTupleIsValid, ObjectIdGetDatum(), ScanKeyInit(), systable_beginscan(), systable_endscan(), systable_getnext(), table_close(), and table_open().

Referenced by has_lo_priv_byid(), inv_open(), and LargeObjectExists().

Variable Documentation

FormData_pg_largeobject

FormData_pg_largeobject

Definition at line 39 of file pg_largeobject.h.