FlightSqlDriverLoader.cs

/*
* 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.
*/

using System.IO;
using System.Runtime.InteropServices;
using Apache.Arrow.Adbc.C;

namespace Apache.Arrow.Adbc.Drivers.Interop.FlightSql
{
    /// <summary>
    /// Lightweight class for loading the Flight SQL Go driver to .NET.
    /// </summary>
    public class FlightSqlDriverLoader
    {
        /// <summary>
        /// Loads the Flight SQL Go driver from the current directory using the default name and entry point.
        /// </summary>
        /// <returns>An <see cref="AdbcDriver"/> based on the Flight SQL Go driver.</returns>
        /// <exception cref="FileNotFoundException"></exception>
        public static AdbcDriver LoadDriver()
        {
            string root = "runtimes";
            string native = "native";
            string fileName = $"libadbc_driver_flightsql";
            string file;

            // matches extensions in https://github.com/apache/arrow-adbc/blob/main/go/adbc/pkg/Makefile
            if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
                file = Path.Combine(root, $"linux-{GetArchitecture()}", native, $"{fileName}.so");
            else if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
                file = Path.Combine(root, $"win-{GetArchitecture()}",   native, $"{fileName}.dll");
            else
                file = Path.Combine(root, $"osx-{GetArchitecture()}",   native, $"{fileName}.dylib");

            if (File.Exists(file))
            {
                // get the full path because some .NET versions need it
                file = Path.GetFullPath(file);
            }
            else
            {
                throw new FileNotFoundException($"Cound not find {file}");
            }

            return LoadDriver(file, "FlightSqlDriverInit");
        }

        private static string GetArchitecture()
        {
            return RuntimeInformation.OSArchitecture.ToString().ToLower();
        }

        /// <summary>
        /// Loads the Flight SQL Go driver from the current directory using the default name and entry point.
        /// </summary>
        /// <param name="file">The file to load.</param>
        /// <param name="entryPoint">The entry point of the file.</param>
        /// <returns>An <see cref="AdbcDriver"/> based on the FlightSql Go driver.</returns>
        public static AdbcDriver LoadDriver(string file, string entryPoint)
        {
            AdbcDriver flightSqlDriver = CAdbcDriverImporter.Load(file, entryPoint);

            return flightSqlDriver;
        }
    }
}