Engineering Analytics
Warehouses and Lakes

How to load data from S3 to Typesense

Learn how to use Airbyte to synchronize your S3 data into Typesense within minutes.

TL;DR

This can be done by building a data pipeline manually, usually a Python script (you can leverage a tool as Apache Airflow for this). This process can take more than a full week of development. Or it can be done in minutes on Airbyte in three easy steps:

  1. set up S3 as a source connector (using Auth, or usually an API key)
  2. set up Typesense as a destination connector
  3. define which data you want to transfer and how frequently

You can choose to self-host the pipeline using Airbyte Open Source or have it managed for you with Airbyte Cloud.

This tutorial’s purpose is to show you how.

What is S3

Amazon S3 (Simple Storage Service) is a cloud-based object storage service that provides developers and IT teams with secure, durable, and scalable storage for their data. It allows users to store and retrieve any amount of data from anywhere on the web, making it easy to build and scale applications, backup and archive data, and analyze data. S3 is designed to provide high availability and durability, with data automatically replicated across multiple availability zones within a region. It also offers a range of features such as versioning, lifecycle policies, and access control to help users manage their data effectively.

What is Typesense

Typesense is an open-source, typo-tolerant search engine optimized for an instant (typically sub-50ms) search-like-up-type experience and developer productivity. If you've heard of Elasticsearch or Algolia, a good way to think about Typesense is that it's an open source alternative to Algolia, with some key issues fixed and an easy-to-use battery-powered alternative to Elasticsearch.It works like a CDN, but for Search. Deploy nodes around the world, closest to your users, to provide them an ultra-fast search experience.

Integrate S3 with Typesense in minutes

Try for free now

Prerequisites

  1. A S3 account to transfer your customer data automatically from.
  2. A Typesense account.
  3. An active Airbyte Cloud account, or you can also choose to use Airbyte Open Source locally. You can follow the instructions to set up Airbyte on your system using docker-compose.

Airbyte is an open-source data integration platform that consolidates and streamlines the process of extracting and loading data from multiple data sources to data warehouses. It offers pre-built connectors, including S3 and Typesense, for seamless data migration.

When using Airbyte to move data from S3 to Typesense, it extracts data from S3 using the source connector, converts it into a format Typesense can ingest using the provided schema, and then loads it into Typesense via the destination connector. This allows businesses to leverage their S3 data for advanced analytics and insights within Typesense, simplifying the ETL process and saving significant time and resources.

Step 1: Set up S3 as a source connector

1. Open the Airbyte dashboard and click on "Sources" from the left-hand menu.
2. Click on the "Create Source" button and select "S3" from the list of available connectors.
3. Enter a name for your S3 source and click on "Next".
4. Enter your AWS access key ID and secret access key in the respective fields. You can find these credentials in your AWS account under "Security Credentials".
5. Select the AWS region where your S3 bucket is located from the dropdown menu.
6. Enter the name of your S3 bucket in the "Bucket Name" field.
7. If your S3 bucket is not in the root directory, enter the path to the directory in the "Path Prefix" field.
8. If you want to include only certain files in your data sync, you can enter a file pattern in the "File Pattern" field. For example, "*.csv" will only include CSV files.
9. Click on "Test" to verify your credentials and connection to the S3 bucket.
10. If the test is successful, click on "Create Source" to save your S3 source connector.Once your S3 source connector is set up, you can use it to create a new Airbyte pipeline and sync data from your S3 bucket to your destination of choice.

Step 2: Set up Typesense as a destination connector

1. First, navigate to the Airbyte website and log in to your account.
2. Once you are logged in, click on the "Destinations" tab on the left-hand side of the screen.
3. Scroll down until you find the Typesense destination connector and click on it.
4. You will be prompted to enter your Typesense API key. Enter this information and click "Test Connection" to ensure that the connection is successful.
5. If the connection is successful, click "Save" to save your Typesense destination connector settings.
6. Next, navigate to the "Sources" tab on the left-hand side of the screen and select the source that you want to connect to your Typesense destination.
7. Follow the prompts to enter the necessary information for your source connector, such as the API key or database credentials.
8. Once you have entered all of the necessary information, click "Test Connection" to ensure that the connection is successful.
9. If the connection is successful, click "Save" to save your source connector settings.
10. Finally, click on the "Sync" tab on the left-hand side of the screen and select the source and destination connectors that you want to use for your data sync.
11. Follow the prompts to set up your data sync, such as selecting the tables or data types that you want to sync.
12. Once you have completed all of the necessary steps, click "Start Sync" to begin syncing your data between your source and Typesense destination connectors.

Step 3: Set up a connection to sync your S3 data to Typesense

Once you've successfully connected S3 as a data source and Typesense as a destination in Airbyte, you can set up a data pipeline between them with the following steps:

  1. Create a new connection: On the Airbyte dashboard, navigate to the 'Connections' tab and click the '+ New Connection' button.
  2. Choose your source: Select S3 from the dropdown list of your configured sources.
  3. Select your destination: Choose Typesense from the dropdown list of your configured destinations.
  4. Configure your sync: Define the frequency of your data syncs based on your business needs. Airbyte allows both manual and automatic scheduling for your data refreshes.
  5. Select the data to sync: Choose the specific S3 objects you want to import data from towards Typesense. You can sync all data or select specific tables and fields.
  6. Select the sync mode for your streams: Choose between full refreshes or incremental syncs (with deduplication if you want), and this for all streams or at the stream level. Incremental is only available for streams that have a primary cursor.
  7. Test your connection: Click the 'Test Connection' button to make sure that your setup works. If the connection test is successful, save your configuration.
  8. Start the sync: If the test passes, click 'Set Up Connection'. Airbyte will start moving data from S3 to Typesense according to your settings.

Remember, Airbyte keeps your data in sync at the frequency you determine, ensuring your Typesense data warehouse is always up-to-date with your S3 data.

Use Cases to transfer your S3 data to Typesense

Integrating data from S3 to Typesense provides several benefits. Here are a few use cases:

  1. Advanced Analytics: Typesense’s powerful data processing capabilities enable you to perform complex queries and data analysis on your S3 data, extracting insights that wouldn't be possible within S3 alone.
  2. Data Consolidation: If you're using multiple other sources along with S3, syncing to Typesense allows you to centralize your data for a holistic view of your operations, and to set up a change data capture process so you never have any discrepancies in your data again.
  3. Historical Data Analysis: S3 has limits on historical data. Syncing data to Typesense allows for long-term data retention and analysis of historical trends over time.
  4. Data Security and Compliance: Typesense provides robust data security features. Syncing S3 data to Typesense ensures your data is secured and allows for advanced data governance and compliance management.
  5. Scalability: Typesense can handle large volumes of data without affecting performance, providing an ideal solution for growing businesses with expanding S3 data.
  6. Data Science and Machine Learning: By having S3 data in Typesense, you can apply machine learning models to your data for predictive analytics, customer segmentation, and more.
  7. Reporting and Visualization: While S3 provides reporting tools, data visualization tools like Tableau, PowerBI, Looker (Google Data Studio) can connect to Typesense, providing more advanced business intelligence options. If you have a S3 table that needs to be converted to a Typesense table, Airbyte can do that automatically.

Wrapping Up

To summarize, this tutorial has shown you how to:

  1. Configure a S3 account as an Airbyte data source connector.
  2. Configure Typesense as a data destination connector.
  3. Create an Airbyte data pipeline that will automatically be moving data directly from S3 to Typesense after you set a schedule

With Airbyte, creating data pipelines take minutes, and the data integration possibilities are endless. Airbyte supports the largest catalog of API tools, databases, and files, among other sources. Airbyte's connectors are open-source, so you can add any custom objects to the connector, or even build a new connector from scratch without any local dev environment or any data engineer within 10 minutes with the no-code connector builder.

We look forward to seeing you make use of it! We invite you to join the conversation on our community Slack Channel, or sign up for our newsletter. You should also check out other Airbyte tutorials, and Airbyte’s content hub!

What should you do next?

Hope you enjoyed the reading. Here are the 3 ways we can help you in your data journey:

flag icon
Easily address your data movement needs with Airbyte Cloud
Take the first step towards extensible data movement infrastructure that will give a ton of time back to your data team. 
Get started with Airbyte for free
high five icon
Talk to a data infrastructure expert
Get a free consultation with an Airbyte expert to significantly improve your data movement infrastructure. 
Talk to sales
stars sparkling
Improve your data infrastructure knowledge
Subscribe to our monthly newsletter and get the community’s new enlightening content along with Airbyte’s progress in their mission to solve data integration once and for all.
Subscribe to newsletter

Connectors Used

Frequently Asked Questions

What data can you extract from S3?

Amazon S3's API provides access to a wide range of data types, including:

1. Object data: This includes the actual files stored in S3 buckets, such as images, videos, documents, and other types of files.
2. Metadata: S3 stores metadata about each object, including information such as the object's size, creation date, and last modified date.
3. Access control data: S3 provides access control mechanisms to restrict access to objects in a bucket. The API provides access to information about access control policies and permissions.
4. Bucket data: S3 buckets are containers for objects. The API provides access to information about buckets, such as their names, creation dates, and region.
5. Logging data: S3 can log access requests to objects in a bucket. The API provides access to these logs, which can be used for auditing and compliance purposes.
6. Inventory data: S3 can generate inventory reports that provide information about the objects stored in a bucket. The API provides access to these reports.
7. Metrics data: S3 can generate metrics about the usage of a bucket, such as the number of requests and the amount of data transferred. The API provides access to these metrics.

What data can you transfer to Typesense?

You can transfer a wide variety of data to Typesense. This usually includes structured, semi-structured, and unstructured data like transaction records, log files, JSON data, CSV files, and more, allowing robust, scalable data integration and analysis.

What are top ETL tools to transfer data from S3 to Typesense?

The most prominent ETL tools to transfer data from S3 to Typesense include:

  • Airbyte
  • Fivetran
  • Stitch
  • Matillion
  • Talend Data Integration

These tools help in extracting data from S3 and various sources (APIs, databases, and more), transforming it efficiently, and loading it into Typesense and other databases, data warehouses and data lakes, enhancing data management capabilities.