@ngageoint/geopackage/dist/lib/db/table/tableColumn.d.ts

GeoPackage JavaScript Library

import { GeoPackageDataType } from '../geoPackageDataType';
/**
 * Table raw or unparsed constraint
 */
export declare class TableColumn {
    /**
     * Column index
     */
    index: number;
    /**
     * Column name
     */
    name: string;
    /**
     * Column type
     */
    type: string;
    /**
     * Column data type
     */
    dataType: GeoPackageDataType;
    /**
     * Column max value
     */
    max: number;
    /**
     * Column not null flag
     */
    notNull: boolean;
    /**
     * Default value as a string
     */
    defaultValueString: string;
    /**
     * Default value
     */
    defaultValue: any;
    /**
     * Primary key flag
     */
    primaryKey: boolean;
    /**
     * Autoincrement flag
     */
    autoincrement: boolean;
    /**
     * Constructor
     *
     * @param index column index
     * @param name column name
     * @param type column type
     * @param dataType column data type
     * @param max max value
     * @param notNull not null flag
     * @param defaultValueString default value as a string
     * @param defaultValue default value
     * @param primaryKey primary key flag
     * @param autoincrement autoincrement flag
     */
    constructor(index: number, name: string, type: string, dataType: GeoPackageDataType, max: number, notNull: boolean, defaultValueString: string, defaultValue: any, primaryKey: boolean, autoincrement: boolean);
    /**
     * Get the column index
     *
     * @return column index
     */
    getIndex(): number;
    /**
     * Get the column name
     *
     * @return column name
     */
    getName(): string;
    /**
     * Get the column type
     *
     * @return column type
     */
    getType(): string;
    /**
     * Get the column data type
     *
     * @return column data type, may be null
     */
    getDataType(): GeoPackageDataType;
    /**
     * Is the column the data type
     * @param dataType data type
     * @return true if the data type
     */
    isDataType(dataType: GeoPackageDataType): boolean;
    /**
     * Get the column max value
     * @return max value or null if no max
     */
    getMax(): number;
    /**
     * Is this a not null column?
     * @return true if not nullable
     */
    isNotNull(): boolean;
    /**
     * Get the default value as a string
     * @return default value as a string
     */
    getDefaultValueString(): string;
    /**
     * Get the default value
     * @return default value
     */
    getDefaultValue(): any;
    /**
     * Is this a primary key column?
     * @return true if primary key column
     */
    isPrimaryKey(): boolean;
    /**
     * Is this an autoincrement column?
     * @return true if an autoincrement column
     */
    isAutoIncrement(): boolean;
}