How to use

getDatabaseStructure

method

in

org.hibernate.id.enhanced.SequenceStyleGenerator

@Override
public boolean supportsBulkInsertionIdentifierGeneration() {
  // it does, as long as
  // 		1) there is no (non-noop) optimizer in use
  //		2) the underlying structure is a sequence
  return NoopOptimizer.class.isInstance( getOptimizer() )
      && getDatabaseStructure().isPhysicalSequence();
}

@Override
public String determineBulkInsertionIdentifierGenerationSelectFragment(Dialect dialect) {
  return dialect.getSelectSequenceNextValString( getDatabaseStructure().getName() );
}

@Test
public void testAutoEntity() {
  final EntityPersister persister = sessionFactory().getEntityPersister( AutoEntity.class.getName() );
  IdentifierGenerator generator = persister.getIdentifierGenerator();
  assertTrue( SequenceStyleGenerator.class.isInstance( generator ) );
  SequenceStyleGenerator seqGenerator = (SequenceStyleGenerator) generator;
  assertEquals( SequenceStyleGenerator.DEF_SEQUENCE_NAME, seqGenerator.getDatabaseStructure().getName() );
  assertEquals( SequenceStyleGenerator.DEFAULT_INITIAL_VALUE, seqGenerator.getDatabaseStructure().getInitialValue() );
  assertEquals( SequenceStyleGenerator.DEFAULT_INCREMENT_SIZE, seqGenerator.getDatabaseStructure().getIncrementSize() );
}

@Test
public void testMinimalSequenceEntity() {
  final EntityPersister persister = sessionFactory().getEntityPersister( MinimalSequenceEntity.class.getName() );
  IdentifierGenerator generator = persister.getIdentifierGenerator();
  assertTrue( SequenceStyleGenerator.class.isInstance( generator ) );
  SequenceStyleGenerator seqGenerator = (SequenceStyleGenerator) generator;
  assertEquals( MinimalSequenceEntity.SEQ_NAME, seqGenerator.getDatabaseStructure().getName() );
  // 1 is the annotation default
  assertEquals( 1, seqGenerator.getDatabaseStructure().getInitialValue() );
  // 50 is the annotation default
  assertEquals( 50, seqGenerator.getDatabaseStructure().getIncrementSize() );
  assertFalse( NoopOptimizer.class.isInstance( seqGenerator.getOptimizer() ) );
}

@Test
public void testCompleteSequenceEntity() {
  final EntityPersister persister = sessionFactory().getEntityPersister( CompleteSequenceEntity.class.getName() );
  IdentifierGenerator generator = persister.getIdentifierGenerator();
  assertTrue( SequenceStyleGenerator.class.isInstance( generator ) );
  SequenceStyleGenerator seqGenerator = (SequenceStyleGenerator) generator;
  assertEquals( 1000, seqGenerator.getDatabaseStructure().getInitialValue() );
  assertEquals( 52, seqGenerator.getDatabaseStructure().getIncrementSize() );
  assertFalse( NoopOptimizer.class.isInstance( seqGenerator.getOptimizer() ) );
}

@Test
public void baseline() {
  final StandardServiceRegistry ssr = new StandardServiceRegistryBuilder().build();
  final Metadata bootModel = new MetadataSources( ssr )
      .addAnnotatedClass( ExplicitGeneratorEntity.class )
      .buildMetadata();
  final PersistentClass entityMapping = bootModel.getEntityBinding( ExplicitGeneratorEntity.class.getName() );
  final IdentifierGenerator generator  = entityMapping.getIdentifier().createIdentifierGenerator(
      bootModel.getIdentifierGeneratorFactory(),
      ssr.getService( JdbcEnvironment.class ).getDialect(),
      null,
      null,
      (RootClass) entityMapping
  );
  final SequenceStyleGenerator sequenceStyleGenerator = assertTyping( SequenceStyleGenerator.class, generator );
  assertThat( sequenceStyleGenerator.getDatabaseStructure().getName(), is( "my_real_db_sequence" ) );
  // all the JPA defaults since they were not defined
  assertThat( sequenceStyleGenerator.getDatabaseStructure().getInitialValue(), is( 100 ) );
  assertThat( sequenceStyleGenerator.getDatabaseStructure().getIncrementSize(), is( 500 ) );
}

@Test
public void testImplicitSequenceGeneratorGeneratorName() {
  final StandardServiceRegistry ssr = new StandardServiceRegistryBuilder().build();
  final Metadata bootModel = new MetadataSources( ssr )
      .addAnnotatedClass( ImplicitSequenceGeneratorEntity.class )
      .buildMetadata();
  final PersistentClass entityMapping = bootModel.getEntityBinding( ImplicitSequenceGeneratorEntity.class.getName() );
  final IdentifierGenerator generator  = entityMapping.getIdentifier().createIdentifierGenerator(
      bootModel.getIdentifierGeneratorFactory(),
      ssr.getService( JdbcEnvironment.class ).getDialect(),
      null,
      null,
      (RootClass) entityMapping
  );
  final SequenceStyleGenerator sequenceStyleGenerator = assertTyping( SequenceStyleGenerator.class, generator );
  // PREFER_GENERATOR_NAME_AS_DEFAULT_SEQUENCE_NAME == true (the default) indicates that the generator-name
  //		should be used as the default instead.
  assertThat( sequenceStyleGenerator.getDatabaseStructure().getName(), is( "my_db_sequence" ) );
  // the JPA defaults since they were not defined
  assertThat( sequenceStyleGenerator.getDatabaseStructure().getInitialValue(), is( 1 ) );
  assertThat( sequenceStyleGenerator.getDatabaseStructure().getIncrementSize(), is( 50 ) );
}

@Test
public void testImplicitSequenceGenerator() {
  final StandardServiceRegistry ssr = new StandardServiceRegistryBuilder()
      .applySetting( AvailableSettings.PREFER_GENERATOR_NAME_AS_DEFAULT_SEQUENCE_NAME, "false" )
      .build();
  final Metadata bootModel = new MetadataSources( ssr )
      .addAnnotatedClass( ImplicitSequenceGeneratorEntity.class )
      .buildMetadata();
  final PersistentClass entityMapping = bootModel.getEntityBinding( ImplicitSequenceGeneratorEntity.class.getName() );
  final IdentifierGenerator generator  = entityMapping.getIdentifier().createIdentifierGenerator(
      bootModel.getIdentifierGeneratorFactory(),
      ssr.getService( JdbcEnvironment.class ).getDialect(),
      null,
      null,
      (RootClass) entityMapping
  );
  final SequenceStyleGenerator sequenceStyleGenerator = assertTyping( SequenceStyleGenerator.class, generator );
  // PREFER_GENERATOR_NAME_AS_DEFAULT_SEQUENCE_NAME == false indicates that the legacy
  // 		default (hibernate_sequence) should be used
  assertThat( sequenceStyleGenerator.getDatabaseStructure().getName(), is( "hibernate_sequence" ) );
  // the JPA defaults since they were not defined
  assertThat( sequenceStyleGenerator.getDatabaseStructure().getInitialValue(), is( 1 ) );
  assertThat( sequenceStyleGenerator.getDatabaseStructure().getIncrementSize(), is( 50 ) );
}

@Test
public void testExplicitSequenceGeneratorImplicitName() {
  final StandardServiceRegistry ssr = new StandardServiceRegistryBuilder()
      .applySetting( AvailableSettings.PREFER_GENERATOR_NAME_AS_DEFAULT_SEQUENCE_NAME, "false" )
      .build();
  final Metadata bootModel = new MetadataSources( ssr )
      .addAnnotatedClass( ExplicitSequenceGeneratorImplicitNameEntity.class )
      .buildMetadata();
  final PersistentClass entityMapping = bootModel.getEntityBinding( ExplicitSequenceGeneratorImplicitNameEntity.class.getName() );
  final IdentifierGenerator generator  = entityMapping.getIdentifier().createIdentifierGenerator(
      bootModel.getIdentifierGeneratorFactory(),
      ssr.getService( JdbcEnvironment.class ).getDialect(),
      null,
      null,
      (RootClass) entityMapping
  );
  final SequenceStyleGenerator sequenceStyleGenerator = assertTyping( SequenceStyleGenerator.class, generator );
  // all the JPA defaults since they were not defined
  assertThat( sequenceStyleGenerator.getDatabaseStructure().getName(), is( SequenceStyleGenerator.DEF_SEQUENCE_NAME ) );
  assertThat( sequenceStyleGenerator.getDatabaseStructure().getInitialValue(), is( 100 ) );
  assertThat( sequenceStyleGenerator.getDatabaseStructure().getIncrementSize(), is( 500 ) );
}

assertThat( sequenceStyleGenerator.getDatabaseStructure().getName(), is( "my_db_sequence" ) );
assertThat( sequenceStyleGenerator.getDatabaseStructure().getInitialValue(), is( 100 ) );
assertThat( sequenceStyleGenerator.getDatabaseStructure().getIncrementSize(), is( 500 ) );

  @Test
  @TestForIssue(jiraKey = "HHH-6790")
  public void testSequencePerEntity() {
    // Checking first entity.
    EntityPersister persister = sessionFactory().getEntityPersister( DedicatedSequenceEntity1.class.getName() );
    IdentifierGenerator generator = persister.getIdentifierGenerator();
    assertTrue( SequenceStyleGenerator.class.isInstance( generator ) );
    SequenceStyleGenerator seqGenerator = (SequenceStyleGenerator) generator;
    assertEquals(
        StringHelper.unqualifyEntityName( DedicatedSequenceEntity1.class.getName() ) + DedicatedSequenceEntity1.SEQUENCE_SUFFIX,
        seqGenerator.getDatabaseStructure().getName()
    );

    // Checking second entity.
    persister = sessionFactory().getEntityPersister( DedicatedSequenceEntity2.class.getName() );
    generator = persister.getIdentifierGenerator();
    assertTrue( SequenceStyleGenerator.class.isInstance( generator ) );
    seqGenerator = (SequenceStyleGenerator) generator;
    assertEquals(
        DedicatedSequenceEntity2.ENTITY_NAME + DedicatedSequenceEntity1.SEQUENCE_SUFFIX,
        seqGenerator.getDatabaseStructure().getName()
    );
  }
}

assertTrue(
    "table structure was not used",
    TableStructure.class.isInstance( generator.getDatabaseStructure() )
);
assertTrue(
  long expectedId = i + 1;
  assertEquals( expectedId, entities[i].getId().longValue() );
  assertEquals( expectedId, generator.getDatabaseStructure().getTimesAccessed() );
  assertEquals( expectedId, ( (BasicHolder) generator.getOptimizer().getLastSourceValue() ).getActualLongValue() );

  entities[i] = new Entity( "" + ( i + 1 ) );
  s.save( entities[i] );
  assertEquals( 2, generator.getDatabaseStructure().getTimesAccessed() ); // initialization calls seq twice
  assertEquals( increment + 1, ( (BasicHolder) optimizer.getLastSourceValue() ).getActualLongValue() ); // initialization calls seq twice
  assertEquals( i + 1, ( (BasicHolder) optimizer.getLastValue() ).getActualLongValue() );
assertEquals( 3, generator.getDatabaseStructure().getTimesAccessed() ); // initialization (2) + clock over
assertEquals( ( increment * 2 ) + 1, ( (BasicHolder) optimizer.getLastSourceValue() ).getActualLongValue() ); // initialization (2) + clock over
assertEquals( increment + 2, ( (BasicHolder) optimizer.getLastValue() ).getActualLongValue() );

assertTrue(
    "table structure was not used",
    TableStructure.class.isInstance( generator.getDatabaseStructure() )
);
assertTrue(
  assertEquals( expectedId, entities[i].getId().longValue() );
  assertEquals( 2, generator.getDatabaseStructure().getTimesAccessed() );
  assertEquals( increment + 1, ( (BasicHolder) optimizer.getLastSourceValue() ).getActualLongValue() );
  assertEquals( i + 1, ( (BasicHolder) optimizer.getLastValue() ).getActualLongValue() );
assertEquals( expectedId, entities[ increment + 1 ].getId().longValue() );
assertEquals( 3, generator.getDatabaseStructure().getTimesAccessed() );
assertEquals( ( increment * 2 ) + 1, ( (BasicHolder) optimizer.getLastSourceValue() ).getActualLongValue() );
assertEquals( increment + 2, ( (BasicHolder) optimizer.getLastValue() ).getActualLongValue() );

  entities[i] = new Entity( "" + ( i + 1 ) );
  s.save( entities[i] );
  assertEquals( 1, generator.getDatabaseStructure().getTimesAccessed() ); // initialization
  assertEquals( 1, ( (BasicHolder) optimizer.getLastSourceValue() ).getActualLongValue() ); // initialization
  assertEquals( i + 1, ( (BasicHolder) optimizer.getLastValue() ).getActualLongValue() );
assertEquals( 2, generator.getDatabaseStructure().getTimesAccessed() ); // initialization
assertEquals( 2, ( (BasicHolder) optimizer.getLastSourceValue() ).getActualLongValue() ); // initialization
assertEquals( increment + 1, ( (BasicHolder) optimizer.getLastValue() ).getActualLongValue() );

assertTrue(
    "table structure was not used",
    TableStructure.class.isInstance( generator.getDatabaseStructure() )
);
assertTrue(

@Override
public boolean supportsBulkInsertionIdentifierGeneration() {
  // it does, as long as
  // 		1) there is no (non-noop) optimizer in use
  //		2) the underlying structure is a sequence
  return OptimizerFactory.NoopOptimizer.class.isInstance( getOptimizer() )
      && getDatabaseStructure().isPhysicalSequence();
}

@Override
public boolean supportsBulkInsertionIdentifierGeneration() {
  // it does, as long as
  // 		1) there is no (non-noop) optimizer in use
  //		2) the underlying structure is a sequence
  return OptimizerFactory.NoopOptimizer.class.isInstance( getOptimizer() )
      && getDatabaseStructure().isPhysicalSequence();
}

@Override
public boolean supportsBulkInsertionIdentifierGeneration() {
  // it does, as long as
  // 		1) there is no (non-noop) optimizer in use
  //		2) the underlying structure is a sequence
  return NoopOptimizer.class.isInstance( getOptimizer() )
      && getDatabaseStructure().isPhysicalSequence();
}

  @Override
  public String determineBulkInsertionIdentifierGenerationSelectFragment(Dialect dialect) {
    return dialect.getSelectSequenceNextValString( getDatabaseStructure().getName() );
  }
}