FilesExpand file tree

 main

/

base.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

46 lines (36 loc) · 1.71 KB

 main

/

base.py

Copy path

Top

File metadata and controls

• Code
• Blame

46 lines (36 loc) · 1.71 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

# 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.

"""This module provides ``BaseInputSource``.

A user can extend this to provide a custom input source.

"""

from abc import ABC, abstractmethod

from typing import Any

from datafusion.common import SqlTable

class BaseInputSource(ABC):

"""Base Input Source class.

If a consuming library would like to provider their own InputSource this is

the class they should extend to write their own.

Once completed the Plugin InputSource can be registered with the

SessionContext to ensure that it will be used in order

to obtain the SqlTable information from the custom datasource.

"""

@abstractmethod

def is_correct_input(self, input_item: Any, table_name: str, **kwargs: Any) -> bool:

"""Returns `True` if the input is valid."""

@abstractmethod

def build_table(self, input_item: Any, table_name: str, **kwarg: Any) -> SqlTable: # type: ignore[invalid-type-form]

"""Create a table from the input source."""