adbc_driver_manager.h

Go to the documentation of this file.

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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.

 
#pragma once
 
#include <arrow-adbc/adbc.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef ADBC_DRIVER_MANAGER_H
#define ADBC_DRIVER_MANAGER_H
 
typedef uint32_t AdbcLoadFlags;
 
#define ADBC_LOAD_FLAG_SEARCH_ENV 1
#define ADBC_LOAD_FLAG_SEARCH_USER 2
#define ADBC_LOAD_FLAG_SEARCH_SYSTEM 4
#define ADBC_LOAD_FLAG_ALLOW_RELATIVE_PATHS 8
 
#define ADBC_LOAD_FLAG_DEFAULT                              \
  (ADBC_LOAD_FLAG_SEARCH_ENV | ADBC_LOAD_FLAG_SEARCH_USER | \
   ADBC_LOAD_FLAG_SEARCH_SYSTEM | ADBC_LOAD_FLAG_ALLOW_RELATIVE_PATHS)

ADBC_EXPORT
AdbcStatusCode AdbcLoadDriver(const char* driver_name, const char* entrypoint,
                              int version, void* driver, struct AdbcError* error);

ADBC_EXPORT
AdbcStatusCode AdbcFindLoadDriver(const char* driver_name, const char* entrypoint,
                                  const int version, const AdbcLoadFlags load_options,
                                  const char* additional_search_path_list, void* driver,
                                  struct AdbcError* error);

ADBC_EXPORT
AdbcStatusCode AdbcLoadDriverFromInitFunc(AdbcDriverInitFunc init_func, int version,
                                          void* driver, struct AdbcError* error);

ADBC_EXPORT
AdbcStatusCode AdbcDriverManagerDatabaseSetInitFunc(struct AdbcDatabase* database,
                                                    AdbcDriverInitFunc init_func,
                                                    struct AdbcError* error);

ADBC_EXPORT
AdbcStatusCode AdbcDriverManagerDatabaseSetLoadFlags(struct AdbcDatabase* database,
                                                     AdbcLoadFlags flags,
                                                     struct AdbcError* error);

ADBC_EXPORT
AdbcStatusCode AdbcDriverManagerDatabaseSetAdditionalSearchPathList(
    struct AdbcDatabase* database, const char* path_list, struct AdbcError* error);

ADBC_EXPORT
const char* AdbcStatusCodeMessage(AdbcStatusCode code);


struct ADBC_EXPORT AdbcConnectionProfile {
  void* private_data;

  void (*release)(struct AdbcConnectionProfile* profile);

  // can be reusable across drivers, then the profile does not need to specify
  AdbcStatusCode (*GetDriverName)(struct AdbcConnectionProfile* profile,
                                  const char** driver_name, AdbcDriverInitFunc* init_func,
                                  struct AdbcError* error);

  AdbcStatusCode (*GetOptions)(struct AdbcConnectionProfile* profile, const char*** keys,
                               const char*** values, size_t* num_options,
                               struct AdbcError* error);

  AdbcStatusCode (*GetIntOptions)(struct AdbcConnectionProfile* profile,
                                  const char*** keys, const int64_t** values,
                                  size_t* num_options, struct AdbcError* error);

  AdbcStatusCode (*GetDoubleOptions)(struct AdbcConnectionProfile* profile,
                                     const char*** keys, const double** values,
                                     size_t* num_options, struct AdbcError* error);
};

typedef AdbcStatusCode (*AdbcConnectionProfileProvider)(
    const char* profile_name, const char* additional_search_path_list,
    struct AdbcConnectionProfile* out, struct AdbcError* error);

ADBC_EXPORT
AdbcStatusCode AdbcDriverManagerDatabaseSetProfileProvider(
    struct AdbcDatabase* database, AdbcConnectionProfileProvider provider,
    struct AdbcError* error);

ADBC_EXPORT
AdbcStatusCode AdbcProfileProviderFilesystem(const char* profile_name,
                                             const char* additional_search_path_list,
                                             struct AdbcConnectionProfile* out,
                                             struct AdbcError* error);

 
#endif  // ADBC_DRIVER_MANAGER_H
 
#ifdef __cplusplus
}
#endif