« Back to Database...

Database Sharding

Introduction #

Database sharding is a way of scaling your database horizontally. For a given table or set of tables, you split up the data that is stored and fetched based on a given hash or something like that. Google, Facebook, and Wikipedia all use database sharding.

Benefits #

  • One database does not get overloaded
  • Smaller queries (since each table has less data now)
  • Better overall throughput under load because all your IO is not going through one database server.

Sharded Portal Instances #

At present, sharding exists in Liferay from version 5.2.3+ for handling data across multiple portal instances. Here's what you do to get it up.

  1. After you have a normally working development environment, make sure your hosts file is setup to allow virtual hosting (for our convenience, I will call the hosts abc1.com, abc2.com, abc3.com, etc.).
  2. Use the create-minimal SQL script (from our Downloads section) to create and populate three database schemas: lportal, lportal1, and lportal2. Be careful and use the scripts for your liferay portal version, otherwise, it won't work. In 6.0, if you simply create several empty database schemas manually, when Liferay starts up with sharding enabled, it will automatically populate the schemas.
    1. Note: By default, the configuration files are setup for three schemas called default, one and two, but you can configure it for more. All this configuration is set up in the file portal-impl/src/META-INF/shard-data-source-spring.xml . As you will see, we will include this file in the property spring.configs in the next step. In case we want to modify it we just should write our own file in the Extension Environment and include it in this property instead of the default one.
  3. In your portal-ext.properties, you will need to set the following:
    1. Enable
      META-INF/shard-data-source-spring.xml
      under
      spring.configs
      .
    2. Configure the jdbc schema settings for
      jdbc.default.*
      ,
      jdbc.one.*
      , and
      jdbc.two.*
      .
    3. Enable the shard names:
      shard.available.names=default,one,two
  4. Don't forget to set the appropriate username and password for each schema.
  5. Startup the server and create several (2-3) portal instances (e.g., abc1.com, abc2.com, abc3.com).
  6. Using your favorite database browser, do a query on each of your schemas for the User_ table, and you will notice that the data is now distributed across different schemas. That's it!

Additional Settings #

  • Remember that default, one, and two are default values defined in portal-impl/src/META-INF/shard-data-source-spring.xml and portal-ext.properties. If you want to change it, make sure to propagate the changes to the spring XML file as well as portal-ext.properties.
  • If you want to manually select the shard (via the GUI when creating portal instances), you need to enable in your portal-ext.properties file:
    shard.selector=com.liferay.portal.dao.shard.ManualShardSelector
    . Otherwise, the shard for the data will be chosen using a round robin technique.
  • Due to the nature of sharding across multiple data sources, it does not support transaction management by itself. In order to enable proper transaction management, you will need to configure JTA/XA. For example, see JTA-XA on Tomcat.
0 Attachments
14774 Views
Average (2 Votes)
Comments

Showing 7 Comments

Aritz Galdos
7/20/09 12:32 AM

I´ll try it right now. Will comment soon

Aritz Galdos
7/20/09 1:22 AM

Great!! It simply works!!

Jonas Yuan
7/25/09 7:48 AM

Very good feature!

Ahmed Hasan
12/2/09 9:53 AM

Dear Alex,

It would be really nice if a new database schema is created when the adminstrator creates an instance, so that we need not have to do all configuration in properties and xml files and re-start the server.

Faisal K
2/19/10 8:48 AM

Is Sharding works fine with 5.2.3 - it is mentioned 5.2.3+, I am getting Exception like this
Caused by: org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'liferayTransactionManager' defined in class path resource [META-INF/hibernate-spring.xml]: Cannot resolve reference to bean 'liferayHibernateSessionFactory' while setting bean property 'sessionFactory'; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'liferayHibernateSessionFactory' defined in class path resource [META-INF/shard-data-source-spring.xml]: Cannot resolve reference to bean 'shardSessionFactoryTargetSource' while setting bean property 'targetSource'; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'shardSessionFactoryTargetSource' defined in class path resource [META-INF/shard-data-source-spring.xml]: Cannot create inner bean 'com.liferay.portal.spring.hibernate.PortalHibernateConfiguration#88d319' of type [com.liferay.portal.spring.hibernate.PortalHibernateConfiguration] while setting bean property 'sessionFactories' with key [TypedStringValue: value [one], target type [null]]; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'com.liferay.portal.spring.hibernate.PortalHibernateConfiguration#88d319' defined in class path resource [META-INF/shard-data-source-spring.xml]: Invocation of init method failed; nested exception is org.hibernate.HibernateException: Hibernate Dialect must be explicitly set
at org.springframework.beans.factory.support.BeanDefinitionValueResolver.resolveRef­erence(BeanDefinitionValueResolver.java:275)
at org.springframework.beans.factory.support.BeanDefinitionValueResolver.resolveVal­ueIfNecessary(BeanDefinitionValueResolver.java:104)
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.app­lyPropertyValues(AbstractAutowireCapableBeanFactory.java:1245)
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.pop­ulateBean(AbstractAutowireCapableBeanFactory.java:1010)
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doC­reateBean(AbstractAutowireCapableBeanFactory.java:472)
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory$1.r­un(AbstractAutowireCapableBeanFactory.java:409)
at java.security.AccessController.doPrivileged(Native Method)
at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.cre­ateBean(AbstractAutowireCapableBeanFactory.java:380)
at org.springframework.beans.factory.support.AbstractBeanFactory$1.getObject(Abstra­ctBeanFactory.java:264)
at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingle­ton(DefaultSingletonBeanRegistry.java:222)
at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(Abstract­BeanFactory.java:261)
at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBe­anFactory.java:185)
at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBe­anFactory.java:164)
at org.springframework.beans.factory.support.BeanDefinitionValueResolver.resolveRef­erence(BeanDefinitionValueResolver.java:269)
... 43 more

Ravi Kumar Gupta
11/17/10 3:57 AM

Its great.. definitely will try on 6.0.x

Thanks for sharing.

Kiran K
1/17/12 12:24 AM

It works fine with Liferay 6.1