org.springframework.data.cassandra.repository.MapIdCassandraRepository Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-data-cassandra Show documentation

Cassandra support for Spring Data

There is a newer version: 4.3.2

Show newest version

/*
 * Copyright 2017-2019 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.data.cassandra.repository;

import org.springframework.data.cassandra.core.mapping.BasicMapId;
import org.springframework.data.cassandra.core.mapping.MapId;
import org.springframework.data.cassandra.core.mapping.MapIdentifiable;
import org.springframework.data.cassandra.core.mapping.PrimaryKeyColumn;
import org.springframework.data.repository.NoRepositoryBean;

/**
 * Cassandra repository interface using {@link MapId} to represent Ids.
 * 
 * This interface uses {@link MapId} for the id type, allowing you to annotate entity fields or properties with
 * {@link PrimaryKeyColumn @PrimaryKeyColumn}. Use this interface if you do not require a composite primary key class
 * and want to specify the Id with {@link MapId}.
 * 

 * Steps to use this interface:
 * 

 * Define your entity, including a field or property for each column, including those for partition and (optional)
 * cluster columns.
 * Annotate each partition & cluster field or property with {@link PrimaryKeyColumn @PrimaryKeyColumn}
 * Define your repository interface to be a subinterface of this interface, which uses a provided id type,
 * {@link MapId} (implemented by {@link BasicMapId}).
 * Whenever you need a {@link MapId}, you can use the static factory method {@link BasicMapId#id()} (which is
 * convenient if you import statically) and the builder method {@link MapId#with(String, Object)} to easily construct an
 * id.
 * Optionally, entity class authors can have their entities implement {@link MapIdentifiable}, to make it easier and
 * quicker for entity clients to get the entity's identity.
 * 
 *
 * @author Matthew T. Adams
 * @author Mark Paluch
 * @since 2.0
 * @see CassandraRepository
 * @see MapId
 * @see MapIdentifiable
 */
@NoRepositoryBean
public interface MapIdCassandraRepository extends CassandraRepository {}