edfialliance/ed-fi-kafka-connect repository overview

⁠Ed-Fi Transformations for Apache Kafka® Connect

Single Message Transformations (SMTs)⁠ for Apache Kafka Connect, built on top of Debezium's Kafka Connect image⁠.

• Code of Conduct⁠
• How to Contribute⁠
• List of Contributors⁠
• Copyright and License Notices⁠
• Security⁠
• License⁠

⁠Transformations

See the Kafka documentation⁠ for more details about configuring transformations on how to install transforms.

⁠GenerateIndexFromDmsResource

This transformation builds an index based on a group of values contained in the body of the result, separated by $.

• org.edfi.kafka.connect.transforms.GenerateIndexFromDmsResource
  • works on values.

The transformation defines the following configurations:

• field.name - Comma separated list of fields to be included into building the Index. This fields will be separated by $ and will add descriptor at the end if resource is marked as such.

Here is an example of this transformation configuration:

transforms=GenerateIndexFromDmsResource
transforms.GenerateIndexFromDmsResource.type=org.edfi.kafka.connect.transforms.GenerateIndexFromDmsResource
transforms.GenerateIndexFromDmsResource.field.name=projectName,resourceVersion,resourceName

⁠Legal Information

Copyright (c) 2024 Ed-Fi Alliance, LLC and contributors.

Licensed under the Apache License, Version 2.0 (the "License").

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.

The Ed-Fi Alliance is an initiative of the Michael & Susan Dell Foundation.

⁠Notice about Docker base images

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.