Documentation
    Preparing search index...

    Class GEOMETRY

    A column storing Geometry information. It is only available in PostgreSQL (with PostGIS), MariaDB or MySQL.

    GeoJSON is accepted as input and returned as output.

    In PostGIS, the GeoJSON is parsed using the PostGIS function STGeomFromGeoJSON. In MySQL it is parsed using the function STGeomFromText.

    Therefore, one can just follow the GeoJSON spec for handling geometry objects. See the following examples:

    Fallback policy: If this type is not supported, an error will be raised.

    DataTypes.GEOMETRY
    DataTypes.GEOMETRY('POINT')
    DataTypes.GEOMETRY('POINT', 4326)

    const point = { type: 'Point', coordinates: [-76.984722, 39.807222]}; // GeoJson format: [lng, lat]

    User.create({username: 'username', geometry: point });

    const line = { type: 'LineString', 'coordinates': [ [100.0, 0.0], [101.0, 1.0] ] };

    User.create({username: 'username', geometry: line });

    const polygon = { type: 'Polygon', coordinates: [
                    [ [100.0, 0.0], [101.0, 0.0], [101.0, 1.0],
                      [100.0, 1.0], [100.0, 0.0] ]
                    ]};

    User.create({username: 'username', geometry: polygon });

    const point = {
      type: 'Point',
      coordinates: [-76.984722, 39.807222], // GeoJson format: [lng, lat]
      crs: { type: 'name', properties: { name: 'EPSG:4326'} }
    };

    User.create({username: 'username', geometry: point })

    Hierarchy (View Summary)

    Index
    constructor
    options usageContext
    _checkOptionSupport _construct _getDialect acceptsNull areValuesEqual belongsToDialect clone escape getBindParamSql getDataTypeId parseDatabaseValue sanitize toBindableValue toDialectDataType toSql toString validate withUsageContext getDataTypeId toString
    options: GeometryOptions
    usageContext: DataTypeUseContext | undefined

    Where this DataType is being used.

    Protected_checkOptionSupport

    Protected_construct

    Protected_getDialect

    • Called when a value is retrieved from the Database, and its DataType is specified. Used to normalize values from the database.

      Note: It is also possible to do an initial parsing of a Database value using AbstractDialect#registerDataTypeParser. That normalization uses the type ID from the database instead of a Sequelize Data Type to determine which parser to use, and is called before this method.

      Parameters

      • value: unknown

        The value to parse.

      Returns unknown

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods