IndexStructure Class Reference

Inheritance diagram for IndexStructure:

Public Member Functions
	__construct (ResourceConnection $resource, IndexScopeResolver $indexScopeResolver, FlatScopeResolver $flatScopeResolver, array $columnTypesMap=[])
	delete ($index, array $dimensions=[])
	create ($index, array $fields, array $dimensions=[])

Protected Member Functions
	createFulltextIndex ($tableName)
	configureFulltextTable (Table $table)
	createFlatIndex ($tableName, array $fields)

Protected Attributes
	$columnTypesMap

Detailed Description

Full text search index structure.

Deprecated:

See also

\Magento\ElasticSearch

Definition at line 22 of file IndexStructure.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ResourceConnection	$resource,
		IndexScopeResolver	$indexScopeResolver,
		FlatScopeResolver	$flatScopeResolver,
		array	$columnTypesMap = []
	)

Parameters

ResourceConnection	$resource
IndexScopeResolver	$indexScopeResolver
\Magento\Framework\Indexer\ScopeResolver\FlatScopeResolver	$flatScopeResolver
array	$columnTypesMap

Definition at line 54 of file IndexStructure.php.

      {
        $this->resource = $resource;
        $this->indexScopeResolver = $indexScopeResolver;
        $this->flatScopeResolver = $flatScopeResolver;
        $this->columnTypesMap = array_merge($this->columnTypesMap, $columnTypesMap);
    }

Member Function Documentation

configureFulltextTable()

configureFulltextTable ( Table  $table )

protected

Configure full text index table.

Parameters

Table

$table

Returns

Table

Definition at line 105 of file IndexStructure.php.

    {
        $table->addColumn(
            'entity_id',
            Table::TYPE_INTEGER,
            10,
            ['unsigned' => true, 'nullable' => false],
            'Entity ID'
        )->addColumn(
            'attribute_id',
            Table::TYPE_TEXT,
            255,
            ['unsigned' => true, 'nullable' => true]
        )->addColumn(
            'data_index',
            Table::TYPE_TEXT,
            '4g',
            ['nullable' => true],
            'Data index'
        )->addIndex(
            'idx_primary',
            ['entity_id', 'attribute_id'],
            ['type' => AdapterInterface::INDEX_TYPE_PRIMARY]
        )->addIndex(
            'FTI_FULLTEXT_DATA_INDEX',
            ['data_index'],
            ['type' => AdapterInterface::INDEX_TYPE_FULLTEXT]
        );
        return $table;
    }

create()

create	(		$index,
		array	$fields,
		array	$dimensions = []
	)

Parameters

string	$index
array	$fields
	Dimension[]	$dimensions

Returns

void

Implements IndexStructureInterface.

Definition at line 78 of file IndexStructure.php.

    {
        $this->createFulltextIndex($this->indexScopeResolver->resolve($index, $dimensions));
        if ($fields) {
            $this->createFlatIndex($this->flatScopeResolver->resolve($index, $dimensions), $fields);
        }
    }

createFlatIndex()

createFlatIndex (   $tableName, array  $fields  )

protected

Create flat index.

Parameters

string	$tableName
array	$fields

Exceptions

Definition at line 144 of file IndexStructure.php.

    {
        $table = $this->resource->getConnection()->newTable($tableName);
        $table->addColumn(
            'entity_id',
            Table::TYPE_INTEGER,
            10,
            ['unsigned' => true, 'nullable' => false],
            'Entity ID'
        );
        foreach ($fields as $field) {
            if ($field['type'] !== 'filterable') {
                continue;
            }
            $columnMap = isset($field['dataType']) && isset($this->columnTypesMap[$field['dataType']])
                ? $this->columnTypesMap[$field['dataType']]
                : ['type' => $field['type'], 'size' => isset($field['size']) ? $field['size'] : null];
            $name = $field['name'];
            $type = $columnMap['type'];
            $size = $columnMap['size'];
            $table->addColumn($name, $type, $size);
        }
        $this->resource->getConnection()->createTable($table);
    }

createFulltextIndex()

createFulltextIndex (   $tableName )

protected

Create full text index.

Parameters

string

$tableName

Exceptions

Definition at line 93 of file IndexStructure.php.

    {
        $table = $this->configureFulltextTable($this->resource->getConnection()->newTable($tableName));
        $this->resource->getConnection()->createTable($table);
    }

delete()

delete	(		$index,
		array	$dimensions = []
	)

Parameters

string	$index
	Dimension[]	$dimensions

Returns

void

Implements IndexStructureInterface.

Definition at line 69 of file IndexStructure.php.

    {
        $this->dropTable($this->resource->getConnection(), $this->indexScopeResolver->resolve($index, $dimensions));
        $this->dropTable($this->resource->getConnection(), $this->flatScopeResolver->resolve($index, $dimensions));
    }

Field Documentation

$columnTypesMap

$columnTypesMap

protected

Initial value:

= [
        'varchar'    => ['type' => Table::TYPE_TEXT, 'size' => 255],
        'mediumtext' => ['type' => Table::TYPE_TEXT, 'size' => 16777216],
        'text'       => ['type' => Table::TYPE_TEXT, 'size' => 65536],
    ]

Definition at line 42 of file IndexStructure.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Indexer/IndexStructure.php