IndexStructureInterface.php 1.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. declare(strict_types=1);
  7. namespace Magento\InventoryMultiDimensionalIndexerApi\Model;
  8. /**
  9. * Represent manipulation with index structure
  10. *
  11. * @api
  12. */
  13. interface IndexStructureInterface
  14. {
  15. /**
  16. * Create the Index Structure
  17. *
  18. * @param IndexName $indexName
  19. * @param string $connectionName
  20. * @throws \Magento\Framework\Exception\StateException
  21. * @return void
  22. */
  23. public function create(IndexName $indexName, string $connectionName): void;
  24. /**
  25. * Delete the given Index
  26. *
  27. * @param IndexName $indexName
  28. * @param string $connectionName
  29. * @return void
  30. */
  31. public function delete(IndexName $indexName, string $connectionName): void;
  32. /**
  33. * Checks whether the Index exits
  34. *
  35. * @param IndexName $indexName
  36. * @param string $connectionName
  37. * @return bool
  38. */
  39. public function isExist(IndexName $indexName, string $connectionName): bool;
  40. }