IShardingUpdate.java

/**
 * Copyright 2014 Duan Bingnan
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 *   
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.pinus4j.datalayer.update;

import java.util.List;

import org.pinus4j.cluster.beans.IShardingKey;
import org.pinus4j.entity.meta.EntityPK;
import org.pinus4j.entity.meta.PKValue;
import org.pinus4j.exceptions.DBOperationException;

/**
 * 数据库增删改查操作接口.
 * 
 * @author duanbn
 */
public interface IShardingUpdate extends IDataUpdate {

    /**
     * 保存数据. 当实体对象中表示主键的字段有值时，则使用此值作为主键. 否则根据数据库设置 自动生成主键
     * 
     * @param entity 数据对象
     * @param shardingValue 分库分表因子
     * @return 主键
     * @throws DBOperationException 操作失败
     */
    public PKValue save(Object entity, IShardingKey<?> shardingValue);

    /**
     * 批量保存数据.
     * 
     * @param entities 批量数据对象
     * @param shardingValue 分库分表因子
     * @return 主键
     * @throws DBOperationException 操作失败
     */
    public PKValue[] saveBatch(List<? extends Object> entities, IShardingKey<?> shardingValue, boolean autoGeneratedKeys);

    /**
     * 更新数据. <b>忽略空值的更新</b>
     * 
     * @param entity 数据对象
     * @param shardingValue 分库分表因子
     * @throws DBOperationException 操作失败
     */
    public void update(Object entity, IShardingKey<?> shardingValue);

    /**
     * 单数据库多数据批量更新.
     * 
     * @param entities 批量更新数据
     * @param shardingValue 分库分表因子
     * @throws DBOperationException 操作失败
     */
    public void updateBatch(List<? extends Object> entities, IShardingKey<?> shardingValue);

    /**
     * 根据主键删除数据.
     * 
     * @param pk 主键
     * @param shardingValue 分库分表因子
     * @param clazz 数据对象class
     * @throws DBOperationException 操作失败
     */
    public void removeByPk(EntityPK pk, IShardingKey<?> shardingValue, Class<?> clazz);

    /**
     * 根据主键批量删除数据.
     * 
     * @param pks 主键
     * @param shardingValue 分库分表因子
     * @param clazz 数据对象class
     * @throws DBOperationException 操作失败
     */
    public void removeByPks(List<EntityPK> pks, IShardingKey<?> shardingValue, Class<?> clazz);

}