Creating Analytics User Defined Functions with Python

# distance_library.py
from geopy import distance


class Distance:
    def calculate_geodesic_distance(self, lat1, lon1, lat2, lon2) -> float:
        """Calculate Distance using geodesic distance"""
        return distance.distance((lat1, lon1), (lat2, lon2)).km
}

# test_distance_library.py
from distance_library import Distance

lat1, lon1 = (51.5, 0)
lat2, lon2 = (38.8, -77.1)
distance = Distance().calculate_geodesic_distance(lat1, lon1, lat2, lon2)
print(f"Distance = {distance}km")

Distance = 5933.529953030055km

$ cd distance-lib
$ shiv -o distance-lib.pyz --site-packages . --platform manylinux2010_x86_64 --python-version 39 --only-binary=:all: geopy

$ docker cp ./distance-lib.pyz db:/tmp

root@b970452b1c05:/ curl -X POST -u Administrator:Password -F "type=python" -F "data=@./tmp/distance-lib.pyz" localhost:8095/analytics/library/Default/distlib
{}

CREATE ANALYTICS FUNCTION distance_in_km(lat1, lon1, lat2, lon2) AS "distance_library",
  "Distance.calculate_geodesic_distance" AT distlib;

SELECT distance_in_km(51.5, 0, 38.8, -77.1) as distance

[
  {
    "distance": 5933.5299530300545
  }
]

SELECT distance_in_km(l.geo.lat, l.geo.lon, 51.509865, -0.118092) AS distance_km,
       l.name,
       l.geo.lat,
       l.geo.lon,
       l.activity,
       l.city,
       l.content
FROM `travel-sample`.inventory.landmark l
ORDER BY distance_km ASC
LIMIT 10;

[
  {
    "distance_km": 0.10949047318935648,
    "name": "Somerset House",
    "lat": 51.5108,
    "lon": -0.1176,
    "activity": "see",
    "city": "London",
    "content": "Somerset House is home to three art galleries:  The exceptional '''Courtauld Institute''' displays a collection of 19th and 20th century art, including well-known works by Degas, Matisse and Kandinsky; The Gilbert Collection presents a collection of decorative art; and The Hermitage Rooms, the most recent addition to Somerset House, hosts temporary exhibitions of works on loan from the Hermitage Museum in Saint Petersburg. The central courtyard is filled with fountains in the Summer, but in the Winter, an ice rink is installed, it is very popular, so visitors should book in advance, or expect to wait a long time to skate."
  },
  {
    "distance_km": 0.21578379129743264,
    "name": "Cleopatra's Needle",
    "lat": 51.5085,
    "lon": -0.1203,
    "activity": "see",
    "city": "London",
    "content": "Cleopatra's Needle originated in the ancient [[Egypt]]ian city of [[Cairo/Heliopolis|Heliopolis]], in the Temple of Atum, but the Romans moved it to [[Alexandria]] in 12 BC.  In 1819, viceroy Mehemet Ali presented Cleopatra's Needle to the British, commemorating military victories in Egypt, but it remained in Alexandria until 1877 when transportation was arranged to bring it to London.  On the voyage, the ship capsized in a storm, killing six crewmembers.  Cleopatra's Needle was thought to be lost, but Spanish trawlers found it afloat a few days later, and after some repairs, it arrived in London on 21 Jan 1878. The obelisk is flanked by two faux-sphinxes, which show the effects of bombings of London during World War II.  Today, Cleopatra's Needle shows some wear from exposure to London's damp weather."
  },
  {
    "distance_km": 0.33018072811955557,
    "name": "Southbank Book Market",
    "lat": 51.5073,
    "lon": -0.1157,
    "activity": "buy",
    "city": "London",
    "content": "Daily second-hand book sale near the bank of the Thames. A nice place to just browse for books (classic and modern), maps and prints."
  },
  {
    "distance_km": 0.3494696134418071,
    "name": "London Transport Museum",
    "lat": 51.51227,
    "lon": -0.12133,
    "activity": "see",
    "city": "London",
    "content": "[[London]] (in [[London/Covent Garden|Covent Garden]])"
  },
  {
    "distance_km": 0.3651528780350233,
    "name": "Undercroft",
    "lat": 51.5067,
    "lon": -0.1167,
    "activity": "see",
    "city": "London",
    "content": "London's most famous and popular skateboarding area, situated partly underneath Queen Elizabeth Hall along Queen's Walk and the Thames.  Also popular with graffiti artists, BMXers and so forth."
  },
  {
    "distance_km": 0.37914671765598384,
    "name": "BFI Southbank",
    "lat": 51.5069,
    "lon": -0.1154,
    "activity": "see",
    "city": "London",
    "content": "Tucked under Waterloo Bridge, BFI Southbank, formerly known as the National Film Theatre, pitches itself as the home of film and has three screens showing classic (including silent), foreign language and less mainstream films. Recently redeveloped, it now has a new entrance on Theatre Alley, a shop dedicated to film, an interactive exhibition space and an excellent bar/restaurant at the back. Visitors can also access the Mediatheque - wind your way through the BFI's extensive film and TV archive for free.  Cool bar and restaurant. Tickets are generally available on the spur of the moment."
  },
  {
    "distance_km": 0.3862780897615006,
    "name": "Queen Elizabeth Hall",
    "lat": 51.5066,
    "lon": -0.1162,
    "activity": "see",
    "city": "London",
    "content": "Music venue hosting daily performances. | image=Queen Elizabeth Hall.jpg"
  },
  {
    "distance_km": 0.39853606826308946,
    "name": "The Retro Bar",
    "lat": 51.5091,
    "lon": -0.1237,
    "activity": "drink",
    "city": "London",
    "content": "The antidote to gay bars: a pub-like atmosphere and great music. | image=The Retro Bar.jpg"
  },
  {
    "distance_km": 0.42698474375328754,
    "name": "National Theatre",
    "lat": 51.507,
    "lon": -0.114,
    "activity": "see",
    "city": "London",
    "content": "Three large auditoriums, the Olivier, the Lyttelton and the Cottesloe. The Olivier theatre is the largest with an open stage and a fan shaped auditorium around it. This ensures that all seats provide a good view. Most of the more 'popular' productions are put on here as the space provided is much larger than most theatres. The Lyttelton theatre is more traditional with a procenium arc with good views from most seats. The Cottesloe is a small studio theatre, seating around 400. Some tickets will be available on the day, either day seats (arrive before 09:30 and queue) or standby (arrive before 6PM and queue), or you can buy online. Popular shows, especially those around Christmas in the Olivier sell out months in advance. Tickets to The National Theatre are generally better value than most other theatres. There is also the '£10 Travelex' season in the summer that provides a large number (over 100,000 seats a year) at £10. Booking in advance is required for these. There is also an exhibition space in the Lyttelton theatre foyer that frequently holds popular photographic exhibitions. Free jazz is often played in the evening in the ground floor foyer. During summer there is a free daily outdoor festival of performance, music, comedy and cabaret known as Watch This Space. Deckchairs (and artificial grass) are provided to watch on. Free exhibitions. Backstage tours £5. (http://www.nationaltheatrelondon.com/tickets/)"
  },
  {
    "distance_km": 0.4327278022456244,
    "name": "Concrete",
    "lat": 51.5063,
    "lon": -0.1156,
    "activity": "drink",
    "city": "London",
    "content": "Free nightly music events.  The best place to sample underground electro, indie, dub-step and more."
  }
]